diff --git a/CHANGELOG.md b/CHANGELOG.md index 6198ed17..5719eb92 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -51,7 +51,7 @@ and this project adheres to - πŸ’„(frontend) update DocHeader ui #448 - πŸ’„(frontend) update doc versioning ui #463 - πŸ’„(frontend) update doc summary ui #473 -- πŸ“(doc) update readme.md to match V2 changes #558 +- πŸ“(doc) update readme.md to match V2 changes #558 & #572 ## Fixed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c73f028..20c4e9e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,14 @@ Thank you for taking the time to contribute! Please follow these guidelines to ensure a smooth and productive workflow. πŸš€πŸš€πŸš€ -To get started with the project, please refer to the [README.md](https://github.com/numerique-gouv/impress/blob/main/README.md) for detailed instructions. +To get started with the project, please refer to the [README.md](https://github.com/suitenumerique/docs/blob/main/README.md) for detailed instructions. + +Please also check out our [dev handbook](https://suitenumerique.gitbook.io/handbook) to learn our best practices. + +## Help us with translations + +You can help us with translations on [Crowdin](https://crowdin.com/project/lasuite-docs). +Your language is not there? Request it on our Crowdin page 😊. ## Creating an Issue diff --git a/README.md b/README.md index 27b1af11..27b0e59f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- Docs + Docs

@@ -27,7 +27,7 @@ Docs is a collaborative text editor designed to address common challenges in kno * 😌 Simple collaborative editing without the formatting complexity of markdown * πŸ”Œ Offline? No problem, keep writing, your edits will get synced when back online * πŸ’… Create clean documents with limited but beautiful formatting options and focus on content -* 🧱 Built for productivity (markdown support, many block types, slash commands, markdown support, keyboard shortcuts) (page in french sorry πŸ˜…). +* 🧱 Built for productivity (markdown support, many block types, slash commands, keyboard shortcuts). * ✨ Save time thanks to our AI actions (generate, sum up, correct, translate) ### Collaborate @@ -91,7 +91,7 @@ password: impress $ make run-with-frontend ``` -⚠️ For the frontend developper, it is often better to run the frontend in development mode locally. +⚠️ For the frontend developer, it is often better to run the frontend in development mode locally. To do so, install the frontend dependencies with the following command: @@ -144,12 +144,14 @@ Want to know where the project is headed? [πŸ—ΊοΈ Checkout our roadmap](https:/ ## Licence πŸ“ This work is released under the MIT License (see [LICENSE](https://github.com/suitenumerique/docs/blob/main/LICENSE)). -While Docs is public driven initiative our licence choice is an invitation for private sector actors to use, sell and contribute to the project. +While Docs is a public driven initiative our licence choice is an invitation for private sector actors to use, sell and contribute to the project. ## Contributing πŸ™Œ -This project is intended to be community-driven, so please, do not hesitate to get in touch if you have any question related to our implementation or design decisions. +This project is intended to be community-driven, so please, do not hesitate to [get in touch](https://matrix.to/#/#docs-official:matrix.org) if you have any question related to our implementation or design decisions. -If you intend to make pull requests see CONTRIBUTING for guidelines. +You can help us with translations on [Crowdin](https://crowdin.com/project/lasuite-docs). + +If you intend to make pull requests see [CONTRIBUTING](https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md) for guidelines. Directory structure: @@ -167,7 +169,15 @@ docs ## Credits ❀️ ### Stack -Impress is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [MinIO](https://min.io/) and [BlocNote.js](https://www.blocknotejs.org/) +Docs is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [MinIO](https://min.io/), [BlockNote.js](https://www.blocknotejs.org/), [HocusPocus](https://tiptap.dev/docs/hocuspocus/introduction) and [Yjs](https://yjs.dev/) -### States ❀️ open source -Docs is the result of a joint effort lead by the French πŸ‡«πŸ‡·πŸ₯– ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German πŸ‡©πŸ‡ͺπŸ₯¨ government ([ZenDiS](https://zendis.de/)). We are always looking for new public partners feel free to reach out if you are interested in using or contributing to docs. \ No newline at end of file +### Gov ❀️ open source +Docs is the result of a joint effort lead by the French πŸ‡«πŸ‡·πŸ₯– ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German πŸ‡©πŸ‡ͺπŸ₯¨ governments ([ZenDiS](https://zendis.de/)). + +We are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/). + +We are always looking for new public partners (we are currently onboarding the Netherlands πŸ‡³πŸ‡±πŸ§€), feel free to [reach out](https://matrix.to/#/#docs-official:matrix.org) if you are interested in using or contributing to Docs. + +

+ +

\ No newline at end of file diff --git a/docs/assets/docs-logo.png b/docs/assets/docs-logo.png new file mode 100644 index 00000000..fe590844 Binary files /dev/null and b/docs/assets/docs-logo.png differ diff --git a/docs/assets/europe<3opensource.png b/docs/assets/europe<3opensource.png new file mode 100644 index 00000000..00606b5e Binary files /dev/null and b/docs/assets/europe<3opensource.png differ diff --git a/docs/assets/logo-docs.png b/docs/assets/logo-docs.png deleted file mode 100644 index 54d3aa4d..00000000 Binary files a/docs/assets/logo-docs.png and /dev/null differ diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 00000000..949969ff Binary files /dev/null and b/docs/assets/logo.png differ