Skip to content

docs: simplify README and define wiki boundary - #5

Merged
icidade merged 1 commit into
mainfrom
docs/wiki-structure-and-readme-simplification
Jul 11, 2026
Merged

docs: simplify README and define wiki boundary#5
icidade merged 1 commit into
mainfrom
docs/wiki-structure-and-readme-simplification

Conversation

@icidade

@icidade icidade commented Jul 11, 2026

Copy link
Copy Markdown
Owner

Summary

  • simplify the main README into a landing-page style entry point
  • add an explicit README vs docs vs Wiki boundary document
  • point readers toward the wiki for editorial/explanatory content

What changed

  • reduced README detail for profiles, self-update, architecture explanation, and external finding workflow
  • grouped documentation links into higher-signal navigation buckets
  • added docs/readme-docs-wiki-boundary.md to formalize the content split

Validation

  • ./scripts/validate-repo.sh
  • local link validation for README and wiki draft
  • local review commit for wiki draft (push still blocked because .wiki.git is not materialized)

Wiki status

The public wiki content was prepared locally, but push to https://github.com/icidade/miniCISO.wiki.git still fails with Repository not found, which suggests the wiki Git backend has not been materialized yet.

@icidade
icidade merged commit 12dc8b4 into main Jul 11, 2026
5 of 7 checks passed
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