docs(landing): make quick starts executable - #2954
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.
D052 — landing-page quick starts and navigation contracts
Refs #2499. This is the single active documentation-quality campaign PR for the frozen D052 rotation-1 batch.
Frozen scope
docs/index.mddocs/README.mddocs/test_landing_page_documentation.pysrc/test/java/neqsim/DocExamplesCompilationTest.javawas inspected and left unchanged because its existingtestDocumentationLandingPageQuickStart()already exercises every NeqSim call and asserts physical density/compressibility ranges. No production Java, API, notebook, dependency, global navigation design, or unrelated documentation is changed.Confirmed defects and evidence
System.out.println, prohibited by the repository’s root instructions even in documentation snippets.docs/index.mdused the legacy high-levelneqsim.thermowrapper instead of the documentation agent’s required publicfrom neqsim import jneqsimgateway.Fixes
NeqSimQuickStartclass withmain, Log4j2 output, the current SRK/TP-flash API, and explicitkg/m3access.jneqsim.thermo.system.SystemSrkEosandjneqsim.thermodynamicoperations.ThermodynamicOperations.Validation performed
Authoritative base:
12b0e2fab3c4ea244a810e8058ca57c08e72631f. Branch head before PR creation:ebce9e9217627445e12df413dbcbb60781433cc2; GitHub reports three commits ahead, zero behind, and exactly the three frozen paths. All three remote blobs exactly match the locally reviewed payload.python -m unittest docs/test_landing_page_documentation.py -v: 4/4 passedpython -m py_compile docs/test_landing_page_documentation.py: passedpython devtools/check_documentation_search.py: passed — 649 Markdown pages and one standalone HTML pageFresh resilient validation environment:
online-new-snapshot39.17 kg/m³Documentation impact: this PR directly repairs the two public landing pages and adds a focused regression contract; no other behavior is user-visible.
LOCAL VALIDATION BLOCKED BY INFRASTRUCTURE
The canonical Maven endpoint was configured, but this runner could not resolve
repo.maven.apache.org. Therefore the following exact commands were attempted and are not claimed as passed:./mvnw -Dmaven.repo.local=/workspace/.cache/maven-d052/repository -Dtest=DocExamplesCompilationTest#testDocumentationLandingPageQuickStart test— blocked resolvingmaven-enforcer-plugin:3.6.3python devtools/run_spotless.py apply— blocked resolving the Spotless Maven pluginpython devtools/run_spotless.py check— blocked resolving the Spotless Maven pluginpre-commit run --all-files --hook-stage pre-commit— pre-commit installed in a fresh 57-wheel verified environment, then blocked only at the Spotless hookpre-commit run --all-files --hook-stage pre-push— documentation-search hook passed; Spotless hook was blocked by the same Maven DNS failureA local Ruby/Jekyll renderer is unavailable, so
bundle exec jekyll build, generated search-index verification, and rendered browser inspection were not run locally; the hosted build/search result is recorded below. No blocked check is reported as successful. The changed files contain no Java source, equations, images, or layout/CSS changes; the Markdown/HTML continuity and destination contracts pass statically.One inherited baseline defect was discovered outside the frozen paths:
docs/test_optimizer_documentation.pyuses\\sin a raw heading regex and its anchor subtests fail on unchangedmaster. This PR neither causes nor masks that failure; it is deferred to a separate bounded batch to avoid mixing optimizer scope into D052.Hosted exact-head validation
All workflows triggered for exact head
ebce9e9217627445e12df413dbcbb60781433cc2completed successfully:spotless.patchis exactly zero bytesThe hosted Jekyll build proves source rendering completes, but it did not publish a browsable artifact for visual inspection. The current-source focused JUnit is also not claimed because the docs-only workflow intentionally skipped Java jobs; the exact snippet was instead compiled/executed against the verified public NeqSim 3.17.0 artifact as recorded above.
Exclusions and next scope
docs/REFERENCE_MANUAL_INDEX.mdremains excluded because open PRs #2086 and #2632 overlap it.docs/quickstart/index.mdanddocs/_config.ymlwere scanned without a confirmed D052 defect. No global HTML redesign, unrelated link normalization, optimizer documentation change, or production-code change is included.D052 remains in progress pending final human/Copilot disposition and, if a compatible artifact becomes available, visual inspection. Current-source focused JUnit execution remains explicitly unclaimed; all hosted checks applicable to this docs-only diff are green.