Skip to content

Simple README.md and large docs/ - #290

Open
nettle wants to merge 1 commit into
Ericsson:mainfrom
nettle:documentation-split
Open

Simple README.md and large docs/#290
nettle wants to merge 1 commit into
Ericsson:mainfrom
nettle:documentation-split

Conversation

@nettle

@nettle nettle commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Why:
The README had grown to about 500 lines, mixing a first contact overview
with the full reference. A landing page should answer what this is and how
to start, nothing more.

What:

  • Move the previous long README.md to docs/README.md
  • Reduce README.md to overview, prerequisites, get started and links
  • Document the minimal integration: bazel_dep with git_override,
    the rules loaded from @rules_codechecker//:defs.bzl

Addresses:
This is the first step for #156

@nettle
nettle force-pushed the documentation-split branch from 7f82283 to 8aaff8d Compare August 13, 2026 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant