Centralized Documentation Hub for cpp-linter Org

[shenxianpeng]

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.

[2bndy5]

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".

[shenxianpeng]

I did something similar for the nRF24 org: https://nrf24.github.io/.github

This is great, we could find themes that match cpp-linter org better.

Created a repo called nRF24.github.io should remove .github from URL if needed.

[2bndy5]

Created a repo called nRF24.github.io should remove .github from URL if needed.

I didn't know about that trick. TBH, the nRF24 org is pretty chill. We pretty much stick to something once it works; following the old adage, "if it isn't broke, then don't try to fix it".

In the case of astral.sh, they must be paying money for that domain. I think they're funded for several reasons, one of them to create their own alternative to PyPI.

[shenxianpeng]

if it isn't broke, then don't try to fix it

Not bad 😊

I don't want to use special domain that need to pay. Just like the astral.sh site they show all their products. It seems that they are ambitious 😱

[shenxianpeng]

I have published the initial doc version here: https://cpp-linter.github.io/. There are still many things that need to be made better.

[2bndy5]

Looks good!

Personally, I won't be writing any blog posts. I think blog posts are more for projects with very large followings and a lot of developers. Also, when there aren't any recent blog posts, it makes the project look dormant to users.

---

1. Should we move this discussion to the cpp-linter.github.io repo (separate issues/discussions)?
2. Should we start a GH "project" to outline a roadmap?

[shenxianpeng]

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

Should we move this discussion to the cpp-linter.github.io repo (separate issues/discussions)?

Done

Should we start a GH "project" to outline a roadmap?

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