Repository navigation
chore: convert 2.6 docs from GitBook to MkDocs - #25
Merged
Merged
Conversation
Contributor
|
📖 Docs preview: https://pr-25-edgetx-lua-reference-guide.edgetx.workers.dev/2.6/ Built from 8cae8ca as the |
Replace the GitBook tree with the MkDocs source the published 2.6 site is already built from: the page content (converted by tools/import_legacy_gitbook.py on edgetx_2.12) in website/md-docs/, a mkdocs.yml for this version, and the uv project files. The branch now builds itself: the publish workflow deploys it as "2.6" on push, and pull requests get a Cloudflare preview. "Edit this page" is enabled and opens this branch. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
Summary
Converts
edgetx_2.6from GitBook to MkDocs, so the branch builds and publishes itself the same wayedgetx_2.12does.website/md-docs/is the output oftools/import_legacy_gitbook.pyfor this branch. It's the same source the live https://luadoc.edgetx.org/2.6/ is already built from at deploy time, now committed. Git detects most pages as renames, so their history carries over. I dropped the duplicateREADME.mdfiles the importer mirrors toindex.md, keeping onlyindex.md.mkdocs.ymlfor 2.6 with the shared theme.edit_uricomes fromDOCS_EDIT_URIand defaults to this branch.pyproject.toml/uv.lock,wrangler.jsonc,.gitignore.publish-versioned-docs.yml(a push to this branch deploys2.6) andpreview-docs.yml(PRs get a Cloudflare preview). Both are identical on every branch. The latest release comes from theDOCS_LATEST_BRANCHrepo variable, withedgetx_2.12as the fallback.Checks
mkdocs buildsucceeds. The remaining warnings are broken links that were already in the original GitBook content.2.6version ongh-pages.content.action.editis enabled, since this branch is now the real source).Before merging
If the GitBook space is still connected to this branch, disconnect its Git sync first. Otherwise GitBook may try to write its own tree back on top of this one.
🤖 Generated with Claude Code