Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 (doc) Slight improvement of README.md #740

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

xibe
Copy link

@xibe xibe commented Mar 17, 2025

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

  • Rewrote the headline.
  • Updated and reorganize the Write/Collaborate/Self-host sections, trying especially to remove negative wording. Also provided link to Markdown syntax, for those who don't know it.
  • Provided a more permanent link for the test environment. Already fixed in 🐛(readme) fix preprod link to redirect to homepage #747
  • Made typographic fixes here and there.

I tried to make the README a bit better and easier to read, by rephrasing a few sentences, moving things around, and in general trying to make it clearer.
@lunika lunika requested a review from virgile-dev March 17, 2025 17:16
@lunika lunika added the documentation Improvements or additions to documentation label Mar 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants