Uh oh!
There was an error while loading. Please reload this page.
Move docs to the repo root - #132
Open
chiruu12 wants to merge 6 commits into
Open
Conversation
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
Greptile SummaryThe PR moves the documentation tree from
Confidence Score: 5/5The PR appears safe to merge because no blocking failure remains within the eligible follow-up review scope. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| mkdocs.yml | Points MkDocs at the root documentation directory, updates edit links, and configures Mermaid custom fences. |
| .github/workflows/docs.yml | Updates documentation workflow path filters so root-level documentation changes continue to trigger strict builds and deployment. |
| sdk/scripts/check_doc_drift.py | Updates documentation discovery to scan Python examples in the relocated root docs tree. |
| sdk/README.md | Adjusts documentation links by one directory level to continue resolving from the SDK README. |
| sdk/tests/integration/test_deployment_modes.py | Updates the deployment-document assertion to resolve the repository-level docs directory from the SDK manifest path. |
Reviews (2): Last reviewed commit: "fix mermaid comment: loader is fetched f..." | Re-trigger Greptile
chiruu12
marked this pull request as draft
August 17, 2026 12:12
chiruu12
commented
Aug 17, 2026
CollaboratorAuthor
# Conflicts: # README.md
chiruu12
marked this pull request as ready for review
August 24, 2026 12:59
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
sdk/docs/ becomes docs/, the layout every comparable repo uses and
the first place a contributor looks.
Site URLs are unchanged since mkdocs derives them from filenames
inside docs_dir. Updated docs_dir, edit_uri, the labeler globs, the
docs workflow path filters, the drift checker globs, the issue and
PR templates, and pyproject's Documentation URL.
Grepping for "sdk/docs" only found 21 of the references. sdk/README.md
and the integration READMEs linked relatively as docs/X.md and
../docs/X.md, twelve files with no "sdk" in the path. A link check
over all tracked markdown found those, and now reports 0 broken links
repo-wide.
test_deployment_doc_exists resolved the doc through
manifest_path().parents[1], which was sdk/. Now parents[2].
Two things not caused by the move, taken while in here: the README
had four em dashes, now commas and full stops; and
.github/actions/unplug-scan/README.md linked to ../workflows/
instead of ../../workflows/.
The nine files GitHub reads by convention stay at root: README,
LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, SUPPORT, plus
Makefile, .gitignore and .pre-commit-config.yaml.