📝(docs) improve readme and add documentation hub#1870
Open
actuallypav wants to merge 1 commit intosuitenumerique:mainfrom
Open
📝(docs) improve readme and add documentation hub#1870actuallypav wants to merge 1 commit intosuitenumerique:mainfrom
actuallypav wants to merge 1 commit intosuitenumerique:mainfrom
Conversation
Rewrite the root README to be more user-facing, add docs/README.md as a documentation landing page, and introduce instances.md for public instances. Signed-off-by: actuallypav <61046893+actuallypav@users.noreply.github.com>
This file contains hidden or 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
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
This pull request improves the project’s documentation entry points and overall readability to make Docs more approachable for new users and contributors.
While reviewing the repository, I noticed that the project highlights documentation and Markdown support, but the front-page README contained several Markdown syntax issues and inconsistencies. This made the landing experience feel less polished than the quality of the project itself. The goal of this change is to provide a cleaner, more consistent, and more professional first impression.
Please let me know and I can apply any changes, or edit other .md files as needed!
Proposal
/docs/README.mdwith a structured table of contentsdocs/instances.mdto list public Docs instancesExternal contributions
Thank you for your contribution! 🎉
Please ensure the following items are checked before submitting your pull request:
git commit --signoff(DCO compliance)git commit -S)<gitmoji>(type) title description## [Unreleased]section