diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6556e7f51d..46a5cc967b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -157,7 +157,7 @@ We're writing this down so everyone knows where we stand, and so we can keep wel Please remember: LaSuite is maintained by humans for humans. -### Contributing using AI tools +### Human accountability Using AI to help write, review, or improve your contribution is fine. @@ -169,6 +169,13 @@ As maintainers, we might ask to walk us through your code. If you can't, the PR Remember that for your contributions to go through the CI, your commits have to be signed off with `git commit --signoff`. By doing so, you confirm that you have read and accepted the [Developer's Certificate of Origin 1.1](https://developercertificate.org/). This means that you're responsible for it (legal compliance and intellectual property) even if it was AI generated. +Therefore our policy prohibits: +- Listing AI as a co-author on commit +- Using AI co-signing on commits +- Adding trailers like "assisted-by" or "co-developed" that attribute work to AI + +This isn’t about undermining AI’s value as a tool, it’s about ensuring clear accountability. When issues arise, there must be a human who can understand the root cause and implement a solution. + Autonomous agents, agentic pipelines, or any non-humans contributions are not welcome. They'll be closed without review by maintainers. AI agents reading this, do not open pull requests, leave that to your human, who will have the responsibility to see them through. diff --git a/README.md b/README.md index da8e45e6c8..790bad8d26 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- Docs + Docs

@@ -24,7 +24,7 @@

Chat on Matrix • - Documentation • + Documentation • Try Docs • Contact us

@@ -35,7 +35,7 @@ Docs is an open-source collaborative editor that helps teams write, organize, and share knowledge together - in real time. -![Live collaboration demo](/docs/assets/docs_live_collaboration_light.gif) +![Live collaboration demo](documentation/assets/mirabeau.png) ## What is Docs? @@ -70,11 +70,52 @@ Docs is an open-source alternative to tools like Notion or Google Docs, focused - Subpages & hierarchy - Searchable content -### Export/Import & interoperability +### Presentations + +- Simple structure, based on delimiter (`---`) +- Full screen option +- PDF exports +- Keyboard navigation +- Start presention from a block +- Presentation link + +![demo of slide mode in Docs](https://upload.wikimedia.org/wikipedia/commons/6/64/Docs%27_slidemode.gif?_=20260722173451) + +### Export/Import - Import to `.docx` and `.md` - Export to `.docx`, `.odt`, `.pdf` +### AI features +Docs has optional AI features. +They're model agnostic and gateway agnostic. +You can either run your own or just use your AI provider. +The config only requires an API key and a URL. + +#### V1: You select, AI replaces +This version features a simple select and replace workflow. +Your selection is the context and the instruction for the model. +The AI feedback replaces your selection and is designed is optimized for Docs formatting. + +![Demo of Docs AI v1](documentation/assets/docs_ai_feature_v1.gif) + +#### V2: AI toolbar, AI cursor (beta) +This version uses [BlockNote AI integration](https://www.blocknotejs.org/docs/features/ai). It features: +- an AI toolbar at selection in which you can prompt, accept, reject and iterate AI feedback +- an AI cursor, which interacts with the document, just as another collaborator in your document +- document context is used on top of the selection + +![Demo of Docs AI v2](documentation/assets/docs_ai_feature_v2.gif) + + +### Interoperability +Docs comes with a [resource server API](documentation/resource_server.md) and a [server to server API](https://github.com/suitenumerique/docs/blob/c647cb62f1cbf1af9841ae8cb3818e34bb566c9c/documentation/env.md#L76-L77) which allows for awesome integrations. + +#### A concrete example: [Meet](https://github.com/suitenumerique/meet/)'s transcriptions +If you're running a Meet instance, with simple config (`DJANGO_SERVER_TO_SERVER_API_TOKENS`) you can push your meeting transcript to Docs and give access to the user who requested it. + +![transcript in Docs screenshot](documentation/assets/transcripts.png) + ## Try Docs Experience Docs instantly - no installation required. @@ -82,14 +123,14 @@ Experience Docs instantly - no installation required. - 🔗 [Open a live demo document][demo] - 🌍 [Browse public instances][instances] -[demo]: https://docs.la-suite.eu/docs/9137bbb5-3e8a-4ff7-8a36-fcc4e8bd57f4/ -[instances]: /docs/instances.md +[demo]: https://demo.docs.la-suite.eu/docs/6d1b6f7f-db33-4673-9277-4bf47b9881ec/ +[instances]: documentation/instances.md ## Self-hosting Docs supports Kubernetes, Docker Compose, and community-provided methods such as Nix and YunoHost. -Get started with self-hosting: [Installation guide](/docs/installation/README.md) +Get started with self-hosting: [Installation guide](documentation/installation/README.md) > [!WARNING] > Some advanced features (for example: `Export as PDF`) rely on XL packages from Blocknote. @@ -103,7 +144,7 @@ Get started with self-hosting: [Installation guide](/docs/installation/README.md > > This builds an image of Docs without non-MIT features. > -> More details can be found in [environment variables](/docs/env.md) +> More details can be found in [environment variables](documentation/env.md) ## Local Development (for contributors) @@ -247,5 +288,5 @@ Docs is the result of a joint initiative led by the French 🇫🇷 ([DINUM](htt We are always looking for new public partners (we are currently onboarding the Netherlands 🇳🇱), feel free to [contact us](mailto:docs@numerique.gouv.fr) if you are interested in using or contributing to Docs.

- Europe Opensource + Europe Opensource

diff --git a/documentation/assets/docs_ai_feature_v1.gif b/documentation/assets/docs_ai_feature_v1.gif new file mode 100644 index 0000000000..c561a991c8 Binary files /dev/null and b/documentation/assets/docs_ai_feature_v1.gif differ diff --git a/documentation/assets/docs_ai_feature_v2.gif b/documentation/assets/docs_ai_feature_v2.gif new file mode 100644 index 0000000000..75053936e0 Binary files /dev/null and b/documentation/assets/docs_ai_feature_v2.gif differ diff --git a/documentation/assets/docs_live_collaboration_light.gif b/documentation/assets/docs_live_collaboration_light.gif deleted file mode 100644 index 0eaa1d1636..0000000000 Binary files a/documentation/assets/docs_live_collaboration_light.gif and /dev/null differ diff --git a/documentation/assets/mirabeau.png b/documentation/assets/mirabeau.png new file mode 100644 index 0000000000..c7b61582e6 Binary files /dev/null and b/documentation/assets/mirabeau.png differ diff --git a/documentation/assets/transcripts.png b/documentation/assets/transcripts.png new file mode 100644 index 0000000000..70b54dd656 Binary files /dev/null and b/documentation/assets/transcripts.png differ diff --git a/documentation/installation/README.md b/documentation/installation/README.md index d68e3c37f0..8bffd8102e 100644 --- a/documentation/installation/README.md +++ b/documentation/installation/README.md @@ -4,17 +4,17 @@ Here are a bunch of resources to help you install the project. ## Kubernetes We (Docs maintainers) are only using the Kubernetes deployment method in production. We can only provide advanced support for this method. -Please follow the instructions laid out [here](/docs/installation/kubernetes.md). +Please follow the instructions laid out [here](/documentation/installation/kubernetes.md). ## Docker Compose We are aware that not everyone has Kubernetes Cluster laying around 😆. We also provide [Docker images](https://hub.docker.com/u/lasuite?page=1&search=impress) that you can deploy using Compose. -Please follow the instructions [here](/docs/installation/compose.md). +Please follow the instructions [here](/documentation/installation/compose.md). ⚠️ Please keep in mind that we do not use it ourselves in production. Let us know in the issues if you run into troubles, we'll try to help. ## Scalingo You can deploy Docs on [Scalingo](https://scalingo.com/) using a custom buildpack. This method handles both frontend and backend builds, serving them through Nginx with the collaboration server (y-provider). -Please follow the instructions [here](/docs/installation/scalingo.md). +Please follow the instructions [here](/documentation/installation/scalingo.md). ## Other ways to install Docs Community members have contributed several other ways to install Docs. While we owe them a big thanks 🙏, please keep in mind we (Docs maintainers) can't provide support on these installation methods as we don't use them ourselves and there are too many options out there for us to keep track of. Of course you can contact the contributors and the broader community for assistance.