docs: rework the README to the org layout - #75
Merged
Merged
Conversation
Follow the layout the other cpp-linter READMEs move to: name, one sentence, a link line, then the existing Build and "Files other projects use" sections, Contributing and License. No badges: this is the site the other READMEs' "part of cpp-linter" badge links to. The Website and "What You'll Find" sections repeated the link line and the site's navigation. The fonts directory URL returns 404 (Pages has no directory index), so show it as a path instead of a link.
✅ Deploy Preview for cpp-linter-github-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
1 participant
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.
Part of aligning the READMEs across the org (same layout as cpp-linter/cpp-linter-hooks#289).
https://cpp-linter.github.io/fonts/is now a path, not a link. It returns 404 because GitHub Pages has no directory index; the font files themselves return 200.All links return 200, and the repo's pre-commit hooks pass.
#20 also edits the MkDocs badge, which this PR removes. If #20 goes ahead, drop its README change when rebasing.