Skip to content

Move docs to the repo root - #132

Open
chiruu12 wants to merge 6 commits into
devfrom
chore/docs-dir
Open

Move docs to the repo root#132
chiruu12 wants to merge 6 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.

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

cursorBot 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.

CopilotAI 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-actionsgithub-actionsBot added documentation Improvements or additions to documentation dependencies Dependency updates ci Build, workflows, or tooling labels Aug 17, 2026
@greptile-apps

greptile-appsBot commented Aug 17, 2026

Copy link
Copy Markdown

Greptile Summary

The PR moves the documentation tree from sdk/docs/ to the repository-level docs/ directory while preserving published page URLs.

  • Updates MkDocs configuration, documentation workflow filters, labeler paths, package metadata, and documentation drift checks.
  • Rewrites repository Markdown links and deployment-document test resolution for the new layout.
  • Adds Mermaid custom-fence rendering configuration and corrects an unrelated workflow link.

Confidence Score: 5/5

The PR appears safe to merge because no blocking failure remains within the eligible follow-up review scope.

No blocking failure remains.

Important Files Changed

FilenameOverview
mkdocs.ymlPoints MkDocs at the root documentation directory, updates edit links, and configures Mermaid custom fences.
.github/workflows/docs.ymlUpdates documentation workflow path filters so root-level documentation changes continue to trigger strict builds and deployment.
sdk/scripts/check_doc_drift.pyUpdates documentation discovery to scan Python examples in the relocated root docs tree.
sdk/README.mdAdjusts documentation links by one directory level to continue resolving from the SDK README.
sdk/tests/integration/test_deployment_modes.pyUpdates 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

@github-actions

github-actionsBot 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 :)

TestsSkippedFailuresErrorsTime
128225 💤0 ❌0 🔥38.716s ⏱️

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

Copy link
Copy Markdown
CollaboratorAuthor

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.

@chiruu12chiruu12 mentioned this pull request Aug 17, 2026
8 tasks
@chiruu12
chiruu12 marked this pull request as ready for review August 24, 2026 12:59
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ciBuild, workflows, or toolingdependenciesDependency updatesdocumentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@chiruu12