Skip to content

Refactor documentation - #297

Open
nettle wants to merge 1 commit into
Ericsson:mainfrom
nettle:docs-refactor
Open

Refactor documentation#297
nettle wants to merge 1 commit into
Ericsson:mainfrom
nettle:docs-refactor

Conversation

@nettle

@nettle nettle commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Why:
The documentation was one 500 line page, no structure.
The contribution page mixed reporting issues with the developer setup.

What:

  • Split docs/README.md into pages
  • Support static rendering with Docsify 5
  • Add pages for the public API, troubleshooting and contributing
  • Reduce CONTRIBUTING.md to reporting issues and a pointer to the docs
  • Update the contents to correspond current status

Addresses:
#156

@furtib
furtib requested review from Szelethus and furtib and a lite review from Copilot and removed request for Copilot August 19, 2026 07:30
@furtib furtib assigned furtib and nettle and unassigned furtib Aug 19, 2026
@furtib furtib added the documentation Improvements or additions to documentation label Aug 19, 2026

@furtib furtib left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!
I was unable to open the HTML file locally, I needed to start a webserver to be able to view it!
Are we / Should we create a github pages for this html page, so users can view this more easily?

Comment thread docs/toolchains.md Outdated
Comment thread docs/troubleshooting.md Outdated
@nettle

nettle commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator Author

I was unable to open the HTML file locally, I needed to start a webserver to be able to view it!

Hm... that should work as a static page, no webserver is required.
I'll check...

Are we / Should we create a github pages for this html page, so users can view this more easily?

Yes, exactly, the simplest way: just publish docs/ as https://ericsson.github.io/rules_codechecker/
(old example: https://nettle.github.io/documentation-template)

@nettle

nettle commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator Author

I was unable to open the HTML file locally, I needed to start a webserver to be able to view it!

Hm... that should work as a static page, no webserver is required. I'll check...

Modern web browsers block loading resources (mostly scripts) when opening local HTML files considering those as potential security threats:

Unsafe attempt to load URL file:///.../index.html from frame with URL file://.../index.html.
'file:' URLs are treated as unique security origins.

So, yes, unfortunately we cannot see this as local file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants