6.x: Create MkDocs documentation site#181
Open
matejsemancik wants to merge 10 commits into
Open
Conversation
Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Reorganize docs into platform-first structure, add component testing guide, expand migration docs into dedicated directory, and remove outdated result.md page. Also remove deprecated BaseComponent APIs. Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Remove inline docs, installation snippets, and feature list in favour of a single link to the MkDocs site. Delete now-unused extras/ assets. Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
matejsemancik
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Introduces a full MkDocs Material documentation site for Arkitekt 6.x, deployed to GitHub Pages at arkitekt.futured.app. The README is replaced with a short pointer to the new site.
Changes
mkdocs.yml— Material theme config with macros plugin, custom Roobert font, and full navigation structuredocs/architecture/— Android (single-page) and KMP (multi-page: Components, State, Events, Navigation, Factory Generator) architecture docsdocs/getting-started/— Installation, project setup, and quick-start guides for both Android and KMP pathsdocs/use-cases/— UseCase, FlowUseCase, Result handling, and error handling docsdocs/testing/— ViewModel testing, UseCase mocking, and component testing docsdocs/migration/android.md— Migration guide for upgrading to 6.xdocs/lint.md— Lint rules documentation.github/workflows/publish_pages.yml— GitHub Pages deployment CI triggered on pushes to6.xREADME.md— Simplified to redirect users to the docs site