Repository navigation
docs(fix[haddock]) Repair native API browser navigation - #5
Merged
Merged
Conversation
tony
added a commit
that referenced
this pull request
Nov 9, 2026
why: The changelog should describe the reader-visible documentation change with its review reference. what: - Record distinct field, method and source navigation in the native browser - Link the artifact and digest workflow to PR #5
tony
added a commit
that referenced
this pull request
Nov 9, 2026
why: Readers need to know how wide API tables behave on phones. what: - Note local scrolling for native declaration and symbol-index sections - Attribute the behavior to pull request #5
6 tasks done
why: Repeated record labels and generated source identifiers make native documentation links ambiguous, while instance details link to absent targets. what: - Prepare a separate HTML copy with owner and instance scoped anchors - Preserve ambiguous legacy links through explicit owner or line choices - Retain raw files, compiled interfaces and source text with digest evidence - Reject missing targets, unexpected duplicates and unsupported native output
why: Contributors need a reproducible native browser with working navigation and a retained original for comparison. what: - Select the local library artifact from Cabal's configured build plan - Run navigation regressions and retain separate raw and prepared CI artifacts - Include preparation tools in the source archive - Document preparation, HTTP search setup and qualification limits
why: Source identifiers can share layout names, and an incomplete browser must not pass preparation or lose files covered by its digest manifest. what: - Keep source choices outside listings and check source text and line anchors - Validate local HTML and CSS assets plus enabled Quick Jump resources - Reject inconsistent search owners while preserving native module reexports - Include generated hidden guide files in both documentation uploads
why: Constructor, instance and symbol-index tables can widen the native API page beyond a phone viewport. what: - Keep wide sections locally scrollable in the prepared default theme - Preserve raw stylesheet bytes and record both stylesheet digests - Describe section scrolling in the native API browser guide
why: Help readers find declarations and use the native API browser. what: - Describe record, instance and source navigation with contained scrolling - Link the documentation changes to PR #5 in one changelog commit
tony
force-pushed
the
feat/capture-recovery
branch
from
November 10, 2026 00:18
b996025 to
ee92f05
Compare
tony
force-pushed
the
fix/haddock-navigation
branch
from
November 10, 2026 00:18
9b7aa46 to
6a3e6c1
Compare
22 of 24 tasks
tony
marked this pull request as ready for review
November 10, 2026 00:25
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.
Stacked on #4, which adds the public Server and snapshot API. Haddock emits ambiguous record-field anchors and instance links without targets for that interface. This change prepares a separate browser copy from the compiled library and retains the original output for comparison.
Summary
Design decisions
Preparation edits generated navigation tags and appends explicit choice destinations. It preserves source text, line anchors, signatures and compiled interfaces. The default theme contains wide declaration and symbol-index tables within narrow viewports. The command qualifies the selected Haddock output and binds Cabal-plan lookup to the local library source.
Missing public targets, unexpected duplicate IDs, inconsistent search owners and incomplete browser assets fail before the output directory appears. Hidden-module instance attributions retain their text and valid source links. Native module reexports keep their own representation.
Both CI uploads include the generated hidden guide files covered by the digest manifest. The command does not establish freshness for arbitrary raw inputs or check external URL availability.
Test plan
The browser check samples Chromium. Source-listing mobile layout, Firefox/WebKit and full accessibility/browser qualification remain open.
Companion PR
Shared Haskell observation and Runtime documentation retains its own source profile and CI gate. This follow-up changes the native artifact workflow.