📝(doc) Slight improvement of README.md #848
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@xibe thanks for taking a stab at this. It looks great. Thanks Also for security reasons you now need to sign your commits (doc on how to proceed) |
virgile-dev
reviewed
Apr 14, 2025
| * 📑 Export your content in multiple formats (`.odt`, `.docx`, `.pdf`) with customizable templates. | ||
| * 📚 _Coming soon! Built-in wiki functionality to turn your team's collaborative work into organized knowledge._ | ||
|
|
||
| > ⚠️ **Note: The docx/pdf exporters rely on [packages Blocknote project](https://github.com/suitenumerique/docs/blob/main/src/frontend/apps/impress/package.json#L22C7-L23C53), which are under the AGPL-3.0 licence. Because the Docs project uses the MIT license, we recommend that you do not run Docs as a commercial product -- unless you are willing to sponsor [BlockNote](https://github.com/TypeCellOS/BlockNote). We are working on complying with the terms of the Blocknote license.** |
There was a problem hiding this comment.
Hey, I've reworked the phrasing for this. As we are working on this : #845
During Docs installation, you will be prompted if you want to install them or not. Please ensure to fulfill your obligation regarding BlockNoteJS licensing (see https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE and https://www.blocknotejs.org/about#partner-with-us).
Also note that Docs works perfectly fine without these export features.```
virgile-dev
reviewed
Apr 14, 2025
|
|
||
| ## Getting started 🔧 | ||
|
|
||
| ### Test it | ||
| ### Test Docs right now! |
There was a problem hiding this comment.
This was recently merged : #812 . Can you update accordingly?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
I tried to make the README file a bit better and easier to read for newcomers, by rephrasing a few sentences, moving things around, and in general trying to make it clearer.
As a next step, we would certainly benefit from re-using the copy on the https://docs.numerique.gouv.fr/ site -- both because it is great, and because it would bring a consistent message throughout.
So please consider this a first pass :)
Proposed changes