Skip to content

Move docs to the repo root - #132

Merged
chiruu12 merged 7 commits into
devfrom
chore/docs-dir
Aug 26, 2026
Merged

Move docs to the repo root#132
chiruu12 merged 7 commits into
devfrom
chore/docs-dir

Conversation

@chiruu12

Copy link
Copy Markdown
Collaborator

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.

Copilot AI lite review requested due to automatic review settings August 17, 2026 12:07
@cursor

cursor Bot commented Aug 17, 2026

Copy link
Copy Markdown

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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions github-actions Bot added documentation Improvements or additions to documentation dependencies Dependency updates ci Build, workflows, or tooling labels Aug 17, 2026
@greptile-apps

greptile-apps Bot commented Aug 17, 2026

Copy link
Copy Markdown

Greptile Summary

The PR relocates the MkDocs source directory from sdk/docs/ to repository-root docs/ while preserving published site routes.

  • Updates MkDocs configuration, documentation workflow filters, labeling, templates, package metadata, and drift-check globs.
  • Rewrites repository-relative documentation links and adjusts the deployment-document integration test for the new layout.
  • Enables Mermaid custom fences in MkDocs and delegates configuration validation to the strict documentation build.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
mkdocs.yml Moves docs_dir and edit links to repository-root documentation and configures Mermaid fences.
.github/workflows/docs.yml Updates documentation workflow path filters so changes under docs/ trigger strict builds and deployment.
sdk/scripts/check_doc_drift.py Retargets API-reference scanning from sdk/docs/*.md to the equivalent root-level documentation glob.
sdk/tests/integration/test_deployment_modes.py Adjusts repository-root traversal so the deployment-document assertion resolves the relocated file.
sdk/README.md Rewrites documentation links relative to the SDK subdirectory for the new root-level location.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  Source["Repository-root docs/"] --> MkDocs["MkDocs strict build"]
  Config["mkdocs.yml"] --> MkDocs
  Workflow["Documentation workflow"] --> MkDocs
  MkDocs --> Artifact["GitHub Pages artifact"]
  Artifact --> Site["Published documentation"]
Loading

Reviews (3): Last reviewed commit: "merge dev into docs move" | Re-trigger Greptile

@github-actions

github-actions Bot commented Aug 17, 2026

Copy link
Copy Markdown

coverage

SDK Coverage •
FileStmtsMissCoverMissing
TOTAL739689688% 
report-only-changed-files is enabled. No files were changed during this commit :)

Tests Skipped Failures Errors Time
1282 25 💤 0 ❌ 0 🔥 39.157s ⏱️

@chiruu12
chiruu12 marked this pull request as draft August 17, 2026 12:12
@chiruu12

Copy link
Copy Markdown
Collaborator Author

Holding this until #130 lands. Both touch README and one of them has to rebase; it should not be the contributor rebasing across a directory rename from here. Will rebase and mark ready once #130 is in.

@chiruu12 chiruu12 mentioned this pull request Aug 17, 2026
8 tasks
@chiruu12
chiruu12 marked this pull request as ready for review August 24, 2026 12:59
@chiruu12
chiruu12 merged commit b4b335f into dev Aug 26, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Build, workflows, or tooling dependencies Dependency updates documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants