docs overhaul

[2bndy5]

• inputs and outputs are in a dedicated page
• README and docs landing page auto-sync with MD substitutions
• permissions are noted where needed per feature (resolves Add documentation for GITHUB_TOKEN requirement #136)
• adds pr-review-caveats doc
• add examples recipes (resolves create an examples folder to demonstrate various usage #195)
• demo folder moved to docs/examples and corresponding CI adjusted

[2bndy5]

mkdocs-build.zip

I'd like to get the reusable workflow to upload these builds as artifacts.

[2bndy5]

I'd like to get the reusable workflow to upload these builds as artifacts.

done

[shenxianpeng]

I got '404 - Not found' when I clicked the link see our Inputs and Outputs document maybe because this PR not be merged?

[shenxianpeng]

I got '404 - Not found' when I clicked the link see our Inputs and Outputs document maybe because this PR not be merged?

OK. I got the docs zip file from GitHub Action artifacts

[shenxianpeng]

LGTM and badge hooks are great.

[shenxianpeng]

I was wondering if this is a feasible idea to have a link (e.g. https://cpp-linter.github.io/cpp-linter) displayed on the cpp-linter org home page with all the documentation including cpp-linter, cpp-linter-action, clang-tools-pip, etc.

Maybe it's better and easier to maintain this separation now.

[2bndy5]

It would be easier for me because I have to scroll down and find it in the list. We could also trade one of the pinned repos for cpp-linter/cpp-linter repo.

[2bndy5]

LGTM and badge hooks are great.

The version and permission badges also serve as links. 🚀

[2bndy5]

I setup a RTD project to build the docs in a PR. This way we don't have to download the build artifact, unzip it, and open it in a browser. Using the CI artifacts does not work on my phone.

[2bndy5]

@shenxianpeng I don't think the todo in https://github.com/orgs/cpp-linter/projects/5?pane=issue&itemId=21348575 is needed any longer, right?

[shenxianpeng]

Yes, I have moved it to Done.

[shenxianpeng]

I setup a RTD project to build the docs in a PR. This way we don't have to download the build artifact, unzip it, and open it in a browser. Using the CI artifacts does not work on my phone.

That's very convenient 👍