docs: docs-as-code documentation system for v0.9.1 - #15
Merged
Merged
Conversation
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
Introduces a complete docs-as-code documentation system for ThreadPool-FP (still v0.9.1). Reuses the proven lightweight, dependency-free static-documentation architecture used by ChronoKit-FP and StringKit-FP and adapts it to ThreadPool-FP's own identity.
What it does
docs/layout.json+docs/versions.json): Getting Started, 12 Guides, Reference, and Internals navigation, with release notes / PR notes / archived plan / ADR kept as hidden-but-searchable pages.GlobalThreadPool,TSimpleThreadPool,IThreadPoolTask,SubmitRange,TryQueue,WaitForAll,Shutdown, ...), keyboard shortcut/./threadpool-fp/0.9.1/with/threadpool-fp/redirect, version selector, light/dark themes, theme selector, mobile nav, TOC, breadcrumbs, prev/next pagination, copy code blocks, offline ZIP + SHA-256.guides/thread-safety.mdandreference/contracts-and-limitations.mdstate exact guarantees (WaitForAll, cancellation, error containment, tombstones, deadlock guards, deadlines, backpressure) verified against source and the test suite.examples/documentation/with expected-output files; code blocks indocs/guides/recipes.mdare checked byte-identical to their source bytools/check_docs.py, andtest_docs_examples.pycompiles and runs them (FPC 3.2.2).build_docs.py,build_all_docs.py,check_docs.py,check_built_docs.pyplus theirtest_*.pysuites; the build fails on broken links, unsafe URLs, layout mismatches, or invalid metadata..github/workflows/documentation.yml(targeted on releases / workflow dispatch) builds, validates, and deploys via currentactions/configure-pages+deploy-pages; CI gains a Documentation checks job and always compiles/run the recipe examples on Windows and Linux.https://ikelaiah.github.io/threadpool-fp/.Verification
All green locally (expected to reproduce in CI):
test_build_docs/test_build_all_docs/test_check_built_docs/test_check_docsunit suitescheck_docs.py+check_built_docs.py --site sitetest_docs_examples.py— 12 programs compiled with FPC 3.2.2 and run against expected outputManual step after merge
Enable Settings → Pages → Source = GitHub Actions so the provided workflow can publish.
Notes
docs/history/and served as hidden, searchable pages — not primary navigation.