Feature/doc update#4
Open
OmerRastgar wants to merge 3 commits into
Open
Conversation
- Set up MkDocs with Material theme, Mermaid diagrams, mkdocstrings, search
- Create full doc structure: architecture, developer, labs, ops, security, community, releases
- Add doc quality tooling: markdownlint, cspell, lychee configs + CI workflows
- Add scripts/check-codeblocks.py and scripts/check-doc-coverage.py for automated validation
- Add CI workflows: docs-quality.yml (lint/link/spell/coverage) and docs.yml (deploy to Pages)
- Add doc standards and contributing guides
- Remove obsolete files: workshop-cloud-llm-setup.md (added to cloud-setup.md)
- Update root README, CONTRIBUTING.md, Makefile, pyproject.toml, pytest.ini, .gitignore
- Remove docs/README.md from sync-docs.py (decoupled from root README)
- Fix sync-docs.py to rewrite relative paths correctly for nested synced files
- Fix remaining root README.md reference to old workshop-cloud-llm-setup.md
- Add coverage script and linter triggers to docs-quality.yml path filters
- Add pymdown-extensions to docs.yml deploy workflow dependencies
- Add check-doc-coverage target to Makefile and include in check-docs
- All routes, modules, code blocks verified clean locally
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.
Key Changes
Verification Results