Skip to content

Move the website's documentation to TF-Minecraft/TFMCWeb - #302

Merged
ryanbarlow97 merged 1 commit into
mainfrom
docs/tfmcweb-moved
Oct 17, 2026
Merged

ryanbarlow97 merged 1 commit into
mainfrom
docs/tfmcweb-moved

Conversation

@ryanbarlow97

Copy link
Copy Markdown
Contributor

Move the website's technical documentation to its source repository. Remove all 56 files under projects/TFMCWeb/ after copying them, with the same layout, to TFMCWeb's root docs/. Earlier document history stays in this repository.

Rewrite all 12 incoming links to absolute TF-Minecraft/TFMCWeb/blob/main/docs/... URLs, covering the root project table and website/backend row, platform guide, TFMCWebBridge guides, SimpleFactions, ArmourShop and DrinkBuilder. Keep TFMCWeb in the project table and record its documentation ownership in MAINTAINING.md. TFMCWebBridge and all other projects stay in Docs. The existing checker already accepts the external project entry, so no checker, unit-test or CI changes are needed.

This PR and TFMCWeb #273 must merge together, TFMCWeb first, so the new destinations exist before this tree is removed. Neither PR is merged by this task.

Validation:

  • python -m pip install -r requirements.txt: passed in an isolated Python 3.12 environment.
  • python -m unittest discover -s scripts -p 'test_*.py': five tests passed.
  • python scripts/check-indexes.py: 709 local links/anchors in 181 Markdown pages, plus project navigation, passed.
  • Strict CoreProtect MkDocs build and git diff --check: passed.
  • Companion throwaway check: 364 relative links/anchors in 60 TFMCWeb Markdown pages and 21 cross-repository links passed; every moved-page anchor/link destination and asset was preserved.
  • TFMCWeb frontend npm run format:check: passed (791 files); TypeScript/YAML edits are comments only.

TFMCWeb's commit includes [skip ci] to honor the no-deploy instruction because its existing Preview workflow deploys branch pushes. Its hosted Actions are intentionally skipped; required hosted checks will need to be arranged before merging. No deployment or server changes are part of these PRs.

Immediately before pushing each branch, open PRs in both repositories were rechecked. Docs #249 also edits README.md and PLATFORM.md; it was left untouched. No other open PR edits projects/TFMCWeb/ or overlaps the changed files.

This change was prepared by an AI agent.

Remove the copied website guides, point their incoming links at the
website repository, and document the ownership exception. TFMCWebBridge
and every other project's guides remain here, along with prior history.

Co-Authored-By: GPT-6.1-Sol <noreply@openai.com>
@ryanbarlow97
ryanbarlow97 merged commit baf9993 into main Oct 17, 2026
1 check passed
@ryanbarlow97
ryanbarlow97 deleted the docs/tfmcweb-moved branch October 17, 2026 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant