Skip to content

fix(docs): simplify Getting Started index and split complete-workflow#40

Merged
beonde merged 1 commit into
mainfrom
fix/docs-p2-getting-started
May 2, 2026
Merged

fix(docs): simplify Getting Started index and split complete-workflow#40
beonde merged 1 commit into
mainfrom
fix/docs-p2-getting-started

Conversation

@beonde
Copy link
Copy Markdown
Member

@beonde beonde commented May 2, 2026

Summary

Simplify the Getting Started section following Diátaxis principles: reduce cognitive load and keep only tutorial-mode content in the tutorial path.

Documentation Audit Reference

Phase: P2-1, P2-2
Severity: Medium

Changes

P2-1: Simplify Getting Started index

  • Removed SDK quick-reference tabs (3 languages × multiple examples)
  • Removed capiscio init walkthrough (moved conceptually to complete-workflow)
  • Removed product matrix and .capiscio/ directory explanation
  • Kept: install command, 4 path-selection cards, prerequisites table, next-steps links

P2-2: Split complete-workflow

  • Removed "Part 6: Monitor Trust Scores" → moved to how-to/validation/trust-scores.md (new file)
  • Removed "Part 7: Production Checklist" → appended to reference/server/deployment.md
  • Tutorial now ends cleanly after Part 5 (gateway deployment) with links to moved content

Navigation

  • Added Trust Scores to how-to/validation nav section in mkdocs.yml

Verification

  • mkdocs build --strict passes
  • Moved content preserved verbatim in new locations
  • All internal links resolve

P2-1: Reduce cognitive load on Getting Started index page. Replace
information-dense SDK quick reference, tabbed code examples, and
product matrix with a clean path-selection card grid.

P2-2: Remove reference-style content from complete-workflow tutorial.
Scoring tables moved to how-to/validation/trust-scores.md,
production checklist moved to reference/server/deployment.md.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

✅ Documentation Build Successful

The documentation build completed successfully and passed validation checks.

  • ✅ Build completed without errors
  • ✅ Critical files present (index.html, sitemap.xml, robots.txt)
  • ✅ Link validation completed

This PR will deploy to dev-docs.capisc.io when merged to main.

@beonde beonde merged commit 5fe2b8a into main May 2, 2026
4 checks passed
@beonde beonde deleted the fix/docs-p2-getting-started branch May 2, 2026 18:50
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