Skip to content

docs: rewrite Understand Kosli section with Diataxis explanation framework#116

Draft
dangrondahl wants to merge 1 commit intomainfrom
how_kosli_works
Draft

docs: rewrite Understand Kosli section with Diataxis explanation framework#116
dangrondahl wants to merge 1 commit intomainfrom
how_kosli_works

Conversation

@dangrondahl
Copy link
Copy Markdown
Contributor

Summary

  • Rewrite the "Understand Kosli" section to follow the Diataxis explanation framework
  • Restructure navigation order for better reading flow: What is Kosli > Risks > Controls > How Kosli works > Glossary
  • Rename concepts.md to how_kosli_works.md with redirect
  • Add new glossary.md reference page with deep-linkable term definitions
  • Enhance all pages with narrative context, design reasoning, and cross-references
  • Correct lifecycle controls to match the SDLC Controls Framework (training, penetration testing, service ownership)
  • Replace concept diagram with updated version

Changes by file

  • what_is_kosli.md: Concise landing page with reading paths (AccordionGroup) and flight recorder metaphor
  • risks.md: Risks grouped into three categories (supply chain, team, runtime) with narrative context
  • controls.md: Per-phase explanations before each control table, corrected lifecycle controls
  • how_kosli_works.md (was concepts.md): Narrative explanation organized by function, not a glossary
  • glossary.md (new): H3-per-term reference page, alphabetically ordered
  • docs.json: Updated navigation order, added redirect
  • sponsors.md, security_compliance.md: Updated cross-references

Test plan

  • Preview with mint dev and verify all pages render correctly
  • Verify navigation order in sidebar
  • Verify redirect from /understand_kosli/concepts works
  • Verify new diagram renders in How Kosli works page
  • Verify glossary TOC sidebar shows all terms
  • Run mint broken-links (no new broken links from these changes)

…ework

Restructure the Understand Kosli section for better reading flow:
- Rewrite what_is_kosli.md as a concise landing page with reading paths
- Rewrite concepts.md as narrative explanation, renamed to how_kosli_works.md
- Enhance risks.md with grouped risk categories and narrative context
- Enhance controls.md with per-phase explanations and corrected lifecycle controls
- Add glossary.md as a reference page with deep-linkable term definitions
- Update navigation order: What is Kosli > Risks > Controls > How Kosli works > Glossary
- Add redirect from /understand_kosli/concepts to /understand_kosli/how_kosli_works
- Replace concept diagram with updated version
- Update cross-references in implementation guide pages
@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Mar 31, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Mar 31, 2026, 4:19 PM

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