Convert selected public APIs into manual references #29

Manually merged
erikinkinen merged 15 commits from feature/docs-manual-api-reference-generation into main 2026-11-21 06:22:10 +01:00
Owner

Convert selected Rustdoc sources through the retained host owner, preserving deterministic public routes, trait identities and wrapping. The manual records each generated API source revision and digest.

Depends on #28. Related allocator API work: erix/lib-owned-region#5.

  • Validate selected sources and tool bindings in the converter.
  • Include the generated owned-region reference in the library index.
  • Publish the source-bound manual with the complete registered reference.
Convert selected Rustdoc sources through the retained host owner, preserving deterministic public routes, trait identities and wrapping. The manual records each generated API source revision and digest. Depends on #28. Related allocator API work: erix/lib-owned-region#5. - [x] Validate selected sources and tool bindings in the converter. - [x] Include the generated owned-region reference in the library index. - [x] Publish the source-bound manual with the complete registered reference.
erikinkinen added this to the Alpha 1 milestone 2026-10-30 13:57:38 +01:00
feat: Convert selected public APIs into manual references
Some checks failed
CI / manual (pull_request) Has been skipped
CI / markdown (pull_request) Has been skipped
CI / markdown (push) Failing after 7s
CI / manual (push) Successful in 9m53s
133f8eef49
Validate selected Rustdoc sources and execute conversion through the retained host owner. Generate deterministic public routes, trait identities and wrapping, and pass explicit source and tool bindings to the converter tests.
docs: Repair Markdown paragraph wrapping
All checks were successful
CI / manual (pull_request) Has been skipped
CI / markdown (pull_request) Has been skipped
CI / markdown (push) Successful in 13s
CI / manual (push) Successful in 9m12s
e83a52534e
Keep the original feature prose and all source inputs while correcting
Markdown spacing and line wrapping.
Author
Owner

The generated lib-owned-region API reference is added to source but absent from this exact-source published manual. Register the generated reference in the manual’s library index. These missing manual sections keep this PR WIP.

The generated lib-owned-region API reference is added to source but absent from this exact-source published manual. Register the generated reference in the manual’s library index. These missing manual sections keep this PR WIP.
fixup! feat: Convert selected public APIs into manual references
All checks were successful
CI / manual (pull_request) Has been skipped
CI / markdown (pull_request) Has been skipped
CI / markdown (push) Successful in 4s
CI / manual (push) Successful in 4m45s
b8dcd1dbef
Register the selected region-allocation API reference in the system-libraries chapter so the published manual includes every generated reference in this feature.
Give the generated compatibility references their actual section parent and link the existing time-service contract.
fixup! feat: Convert selected public APIs into manual references
All checks were successful
CI / manual (pull_request) Has been skipped
CI / markdown (pull_request) Has been skipped
CI / markdown (push) Successful in 4s
CI / manual (push) Successful in 4m40s
c987d4b5fe
Align narrow boot-contract table cells and keep the long intake heading out of the contents column. Select native graphics without an unused external EPS producer.
Author
Owner

Fixed the missing time-service reference and the compatibility section’s bookmark level. The full table contents are retained with legible narrow columns and a shorter table-of-contents entry. The manual now selects its existing PNG/PDF graphics without loading the unused EPS converter.

Fixed the missing time-service reference and the compatibility section’s bookmark level. The full table contents are retained with legible narrow columns and a shorter table-of-contents entry. The manual now selects its existing PNG/PDF graphics without loading the unused EPS converter.
erikinkinen changed title from WIP: Convert selected public APIs into manual references to Convert selected public APIs into manual references 2026-11-14 11:13:48 +01:00
Author
Owner

The missing owned-region API reference is now registered and present in the published manual for this exact head. The generated type and ownership sections were also checked visually. The documentation defect is resolved, so this PR is ready for review.

The missing owned-region API reference is now registered and present in the published manual for this exact head. The generated type and ownership sections were also checked visually. The documentation defect is resolved, so this PR is ready for review.
docs: Specify private memory and region ownership
All checks were successful
CI / markdown (push) Successful in 4s
CI / manual (push) Successful in 4m13s
7f085bf68e
Describe private mappings, retained backing, caller-owned region storage and positive retirement. Document the checks required before changing or reusing mapped storage.
docs: Merge docs: Specify private memory and region ownership
All checks were successful
CI / manual (pull_request) Has been skipped
CI / markdown (pull_request) Has been skipped
CI / markdown (push) Successful in 3s
CI / manual (push) Successful in 4m42s
c2a0a22c61
Integrate the reviewed prepared history into feature/docs-manual-api-reference-generation. The feature tree and
original source branch remain unchanged. Upstream work retains its own
completion requirements.

#30
Describe authenticated submissions, exact reply framing and original caller ownership. Retain the current API generation and private-memory contracts, and fold the paragraph wrapping corrections into their owning feature.
Retain the completed documentation feature on the current invocation-custody history while preserving the independently maintained upstream contracts.
Keep the completed downstream documentation feature and its review boundary together with the invocation-custody work.
Document explicit staged-child authority and cleanup. Replace the earlier rootless-construction summary with the complete wire and ownership contract, retaining its no-sealing guarantee.
Describe native thread authority, TLS custody and initial execution while retaining the current generated-reference publication contract.
Preserve the completed staged-process documentation feature as its own merge boundary.
docs: Merge native thread and TLS ownership
All checks were successful
CI / markdown (push) Successful in 3s
CI / manual (push) Successful in 3m49s
df7a5cf1eb
Preserve the completed native-thread documentation feature as its own merge boundary.
docs: Merge specify native invocation custody
All checks were successful
CI / manual (pull_request) Has been skipped
CI / markdown (pull_request) Has been skipped
CI / markdown (push) Successful in 4s
CI / manual (push) Successful in 4m17s
165b900c76
Integrate the reviewed prepared history into feature/docs-manual-api-reference-generation. The feature tree and
original source branch remain unchanged. Upstream work retains its own
completion requirements.

#31
erikinkinen changed target branch from feature/docs-documentation-governance to main 2026-11-21 06:22:09 +01:00
erikinkinen manually merged commit dbc08ffc65 into main 2026-11-21 06:22:10 +01:00
Sign in to join this conversation.
No description provided.