Repository navigation
docs(repo): give the READMEs a header block and shorter guides - #8
Merged
Merged
Conversation
The root README held 28 lines of maintainer steps and no example. It now has the centred header, a package table with the status of each package, one example and links to the docs site. The steps move to docs/develop.md, and the README links to it. Signed-off-by: MobileMage <aidelojejoshua@gmail.com>
The README repeated the guide on the docs site, which is live. It now has a centred header, a link row, two short examples, a table of the main functions and links to the guide and the reference. The install section says that the first alpha is not published. The README test now checks that the text names each export, because the shorter text shows only the main ones in examples. Signed-off-by: MobileMage <aidelojejoshua@gmail.com>
The README repeated the guide on the docs site, which is live. It now has a centred header, a link row, two short examples, a table of the main calls and links to the guide and the reference. The install section says that the first alpha is not published. The README test now checks that the text names each export. Signed-off-by: MobileMage <aidelojejoshua@gmail.com>
The README now has the centred header and a link row. It says that the image ghcr.io/gatepost-dev/postcode-mock:0.1.0 is not public yet. The long list of behaviours moves to the spec pages that it already named. Signed-off-by: MobileMage <aidelojejoshua@gmail.com>
The package READMEs ship inside the packages, so the release notes must name the change, and the pull request check asks for a change file. Signed-off-by: MobileMage <aidelojejoshua@gmail.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.
The READMEs now have the look that the other Gatepost repos use: a
centred logo with a dark version, a tagline, badges, a row of links
and the notice that the project is unofficial.
The root README becomes a table of the packages with their status. The
core and client READMEs are shorter, because the docs site holds the
full guides and the reference. Each keeps its install command with a
plain note that the first alpha is not on npm yet, two examples that
the tests run, and a table of the main functions. The steps for
maintainers move out of the root README, which links them in one line.
Signed-off-by: MobileMage aidelojejoshua@gmail.com