docs: complete landing index + manual gh-pages publish job (Phase 6) - #125
Merged
Conversation
Rewrite docs-src/index.md to link the full modernized tree (C + C++/STL API, all guides, man pages, per-book PDFs) now that phases 1-5 are done. Add a workflow_dispatch publish job to docs.yml that regenerates HTML+PDF+man and pushes them to gh-pages under /reference/, leaving the landing page and the historical archive untouched.
Coccinelle convention checksNo new violations. ✅ Resolved since baseline (2) -- update dist/cocci/baseline.txt to lock these in. |
ABI diff vs
|
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.
Final docs phase. The modernized reference is already published to gh-pages under /reference/ (1465 HTML pages + 13 PDFs + a 787-page man tarball incl.
libdb(3)), and the libdb.org landing page's Documentation section now points at it (with the original Oracle DocBook manuals kept as a historical archive).This PR lands the matching source changes:
docs-src/index.md— rewritten to link the full tree (C + C++/STL API, Programmer's Reference, all Getting Started guides, installation/upgrading/porting/SQL, man pages, per-book PDFs). It previously only listed the C API + "follow-up phases".docs.ymlpublishjob (workflow_dispatchonly) — regenerates HTML+PDF+man and pushes them togh-pages:/reference/for future releases, leaving the landing page + archive untouched. Manual (not per-push) because publishing is a deliberate act; Pages here is legacy branch-based.Completes the documentation modernization: Markdown source of truth → HTML + PDF + man, single-sourced version/copyright, CI-validated (build/no-loss/completeness/spelling/links/man-lint), published to libdb.org.