From b4760569624fa7b7743d7434fe135b361fb94950 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Thu, 1 Oct 2026 11:14:37 +0300 Subject: [PATCH] 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. --- README.md | 38 +++++++++++++++----------------------- 1 file changed, 15 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 01e8fe4..2f969e1 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,11 @@ # cpp-linter.github.io -[![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/) -[![GitHub Org](https://img.shields.io/badge/github-cpp--linter-181717?logo=github)](https://github.com/cpp-linter) -[![License](https://img.shields.io/github/license/cpp-linter/cpp-linter.github.io)](LICENSE) -[![MkDocs](https://img.shields.io/badge/docs-MkDocs%20Material-526CFE?logo=materialformkdocs&logoColor=white)](https://cpp-linter.github.io/) +The source of : the home page, Get started, Why cpp-linter, the +showcase, the blog and the community and sponsor pages. -Documentation website for the `cpp-linter` project and organization. - -This repository hosts the public site at , including the homepage, getting started guides, and community links for the C/C++ linting ecosystem around `cpp-linter`. - -## Website - -- Main site: -- GitHub organization: - -## What You'll Find - -- Project overview and landing page content -- Getting started documentation -- "Why cpp-linter?": how the toolchain compares with other clang-format / clang-tidy actions and hooks -- Showcase of open-source projects that use cpp-linter -- Blog posts and guides -- Links to the clang tools packages (pip, Homebrew, asdf, static binaries, Docker images, wheels) -- Community entry points and the sponsor page +[Website](https://cpp-linter.github.io/) · +[Get started](https://cpp-linter.github.io/getting-started/) · +[Discussions](https://github.com/orgs/cpp-linter/discussions) ## Build @@ -39,7 +22,16 @@ without updating those repositories: - `docs/stylesheets/shared.css`, served at , is loaded by the docs sites of cpp-linter-action, cpp-linter, clang-tools-pip and cpp-linter-rs. It carries the site's look (colors, header, fonts), so a change to it changes all of them. -- `docs/fonts/`, served at , holds the fonts that +- `docs/fonts/`, served under `https://cpp-linter.github.io/fonts/`, holds the fonts that `shared.css` declares (SIL Open Font License 1.1). Keep the file names in sync with it. - `docs/install-wheel.sh`, served at , is used by the clang-tools-wheel README and its release workflow. + +## Contributing + +See the [contributing guide](https://github.com/cpp-linter/.github/blob/main/CONTRIBUTING.md) and +[open an issue](https://github.com/cpp-linter/cpp-linter.github.io/issues) for anything wrong on the site. + +## License + +[MIT](https://github.com/cpp-linter/cpp-linter.github.io/blob/main/LICENSE)