Skip to content

Documentation rework - #22

Merged
vredchenko merged 3 commits into
mainfrom
documentation-rework
Jan 13, 2026
Merged

vredchenko merged 3 commits into
mainfrom
documentation-rework

Conversation

@vredchenko

@vredchenko vredchenko commented Jan 6, 2026 •

Copy link
Copy Markdown
Collaborator

Documentation migration is complete. Here's a summary of what was done:

Files migrated (21 files):

  • tutorials/installation.md → getting-started/for-developers.md
  • reference/cli-reference.md → agent/cli-reference.md
  • 19 files from how-to/ → appropriate sections (backend/, agent/, operations/, development/)

Index files created/updated:

  • getting-started/index.md, backend/index.md, agent/index.md
  • operations/index.md, development/index.md, architecture/index.md
  • athena/index.md, decision-records/index.md

Root navigation:

  • Updated index.md with audience-based cards (Developers, Operators, Integrators)
  • Component cards (Backend, Agent, Athena)
  • Cross-cutting cards (Operations, Development, Architecture)
  • Renamed terms-and-defs.md → glossary.md

Deleted:

  • Old index files: explanations.md, how-to.md, reference.md, tutorials.md
  • Old directories: tutorials/, how-to/, reference/

The new structure follows ADR-0012's audience/component-based organisation instead of the old Diataxis framework.

@vredchenko
vredchenko force-pushed the documentation-rework branch 2 times, most recently from 2e61556 to fd49a28 Compare January 8, 2026 13:42
@vredchenko
vredchenko force-pushed the documentation-rework branch from fd49a28 to 88bdd8e Compare January 9, 2026 12:20
@vredchenko
vredchenko marked this pull request as ready for review January 13, 2026 11:29
@vredchenko
vredchenko merged commit 75c0f34 into main Jan 13, 2026
4 checks passed
@vredchenko
vredchenko deleted the documentation-rework branch January 13, 2026 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant