Translate the tutorial manual to wodoc (.mld)#40
Draft
balat wants to merge 2 commits into
Draft
Conversation
Both versions (tutos/8.0, tutos/dev) translated in place with `wodoc convert --odoc-refs`, keeping the doc in the main branch (no wikidoc branch). The old .wiki sources are removed (recoverable from git history); menu.wiki is kept as the sidebar navigation source (parsed by gen-manual-nav.py, same as eliom). The themed site is built from these .mld by ocsigen.github.io's wodoc/tuto/ build.sh. Verified: content section headings identical to the live site on all pages (8.0 60/60, dev 61/61).
balat
force-pushed
the
wodoc-doc-migration
branch
from
94a9bfb to
f264b14
Compare
The mld sources kept the old html_of_wiki 'wiki:manual/<page>' abbreviation as the link URL, which 404'd. Point them at the sibling <page>.html, matching the flattened wodoc layout.
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
1 participant
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.
Migrates the main Ocsigen tutorial from extended wikicreole to wodoc
.mld, per the doc-rationalization report §11ter.What
tutos/8.0/manual/,tutos/dev/manual/) withwodoc convert --odoc-refs— tuto keeps its two-versions-in-masterlayout (nowikidocbranch)..wikisources removed (recoverable from git history).menu.wikikept as the sidebar nav source (parsed bygen-manual-nav.py, exactly like eliom's wikidocmenu.wiki).Rendering / verification
The themed site is built from these
.mldbyocsigen.github.io'swodoc/tuto/build.sh(manual-only: drivesodocdirectly, no dune/odoc-driver). Cross-project API refs (eliom, …) resolve to the deployed wodoc docs; tuto-specific blocks (concept/concepts/wip/docblock) and wikicreole tables render correctly.Content section headings compared page-by-page to the live
ocsigen.org/tuto/{8.0,dev}/manual/: 8.0 60/60, dev 61/61 identical.Depends on wodoc PR ocsigen/wodoc#1 (convert/render fixes) and the ocsigen.github.io deploy PR.