Centralized Documentation Hub for cpp-linter Org #161
Replies: 2 comments 5 replies
-
|
I did something similar for the nRF24 org: https://nRF24.github.io/.github The site is hosted from the org repo (nRF24/.github). That is why the URL ends with ".github.io/.github". |
Beta Was this translation helpful? Give feedback.
-
|
I have temporarily hidden the blog. Previously, I posted some blogs related to cpp-linter, maybe some development thoughts and history are interesting for users, I will look back to see if it is still needed
Done
Good idea. Sometimes I forgot to review my created project. Maybe create an issue ticket and add sub-tasks, and it might be easier to see |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
I’m thinking about creating centralized documentation for the cpp-linter org.
Currently, we have separate documentation sites:
cpp-linter-action → cpp-linter-action docs
cpp-linter → cpp-linter docs
cpp-linter-pip → clang-tools-pip docs
The good part is that all of them already use the same documentation theme, which makes things consistent.
As an enhancement, we could introduce a central entry point at cpp-linter.github.io, which would guide users to the right project depending on their needs. (if the effort is not big)
Some projects like clang-tools-static-binaries, clang-tools-docker, clang-tools-wheel (still in progress), etc, don’t yet have online documentation. A central site could make it easier for users to discover them and navigate in the right direction.
We already have a high-level overview in the organization profile README, but maybe this could be enhanced—or complemented—with a single documentation hub that ties everything together.
Like https://astral.sh/
Just noting this idea as a way to make it more user-friendly and help people quickly find what they need.
Beta Was this translation helpful? Give feedback.
All reactions