Skip to content

Commit b476056

Browse files
committed
docs: rework the README to the org layout
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.
1 parent cb2fc3a commit b476056

1 file changed

Lines changed: 15 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,11 @@
11
# cpp-linter.github.io
22

3-
[![Website](https://img.shields.io/static/v1?logo=googlechrome&logoColor=white&label=Website&message=cpp-linter.github.io&color=yellow)](https://cpp-linter.github.io/)
4-
[![GitHub Org](https://img.shields.io/badge/github-cpp--linter-181717?logo=github)](https://github.com/cpp-linter)
5-
[![License](https://img.shields.io/github/license/cpp-linter/cpp-linter.github.io)](LICENSE)
6-
[![MkDocs](https://img.shields.io/badge/docs-MkDocs%20Material-526CFE?logo=materialformkdocs&logoColor=white)](https://cpp-linter.github.io/)
3+
The source of <https://cpp-linter.github.io/>: the home page, Get started, Why cpp-linter, the
4+
showcase, the blog and the community and sponsor pages.
75

8-
Documentation website for the `cpp-linter` project and organization.
9-
10-
This repository hosts the public site at <https://cpp-linter.github.io/>, including the homepage, getting started guides, and community links for the C/C++ linting ecosystem around `cpp-linter`.
11-
12-
## Website
13-
14-
- Main site: <https://cpp-linter.github.io/>
15-
- GitHub organization: <https://github.com/cpp-linter>
16-
17-
## What You'll Find
18-
19-
- Project overview and landing page content
20-
- Getting started documentation
21-
- "Why cpp-linter?": how the toolchain compares with other clang-format / clang-tidy actions and hooks
22-
- Showcase of open-source projects that use cpp-linter
23-
- Blog posts and guides
24-
- Links to the clang tools packages (pip, Homebrew, asdf, static binaries, Docker images, wheels)
25-
- Community entry points and the sponsor page
6+
[Website](https://cpp-linter.github.io/) ·
7+
[Get started](https://cpp-linter.github.io/getting-started/) ·
8+
[Discussions](https://github.com/orgs/cpp-linter/discussions)
269

2710
## Build
2811

@@ -39,7 +22,16 @@ without updating those repositories:
3922
- `docs/stylesheets/shared.css`, served at <https://cpp-linter.github.io/stylesheets/shared.css>,
4023
is loaded by the docs sites of cpp-linter-action, cpp-linter, clang-tools-pip and cpp-linter-rs.
4124
It carries the site's look (colors, header, fonts), so a change to it changes all of them.
42-
- `docs/fonts/`, served at <https://cpp-linter.github.io/fonts/>, holds the fonts that
25+
- `docs/fonts/`, served under `https://cpp-linter.github.io/fonts/`, holds the fonts that
4326
`shared.css` declares (SIL Open Font License 1.1). Keep the file names in sync with it.
4427
- `docs/install-wheel.sh`, served at <https://cpp-linter.github.io/install-wheel.sh>, is used by
4528
the clang-tools-wheel README and its release workflow.
29+
30+
## Contributing
31+
32+
See the [contributing guide](https://github.com/cpp-linter/.github/blob/main/CONTRIBUTING.md) and
33+
[open an issue](https://github.com/cpp-linter/cpp-linter.github.io/issues) for anything wrong on the site.
34+
35+
## License
36+
37+
[MIT](https://github.com/cpp-linter/cpp-linter.github.io/blob/main/LICENSE)

0 commit comments

Comments
 (0)