docs: document both apps and consolidate the docs URL - #13
Open
jkitchin wants to merge 1 commit into
Open
Conversation
Neither GUI was discoverable. The browser app had just shipped and was unmentioned outside webapp/, and the Streamlit DOE app has never appeared in the README or on the docs site despite being a shipped feature since the app extra was added. README and docs/intro.md now both open with the browser app (the lowest-friction way to try JAXSR at all) and carry an "Interactive apps" section covering both front ends, with a table for choosing between them: the browser app for analysing data you already have, the Streamlit app for the design-of-experiments loop where you are deciding what to measure next. Three different URLs were in use for the same documentation site -- the README badge and CITATION.cff pointed at jkitchin.github.io, while pyproject.toml pointed at the GitHub README. All now use the canonical Pages URL, https://kitchingroup.cheme.cmu.edu/jaxsr/, and pyproject gains a "Web app" link so the app is reachable from the PyPI sidebar. HTTPS enforcement is now on for the Pages site, so http:// redirects (301) rather than serving. Verified by building the book with the pinned jupyter-book (<2): the admonition renders, both app links resolve, and warning count is unchanged. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Neither GUI was discoverable. The browser app had just shipped and was unmentioned outside
webapp/; the Streamlit DOE app has never appeared in the README or on the docs sitedespite being a shipped feature since the
appextra was added.What changed
README and
docs/intro.mdboth now open with the browser app — the lowest-friction wayto try JAXSR at all — and carry an "Interactive apps" section covering both front ends, with
a table for choosing between them:
pip install "jaxsr[app]"Docs URL consolidated. Three different URLs were in use for the same site: the README
badge and
CITATION.cffpointed atjkitchin.github.io,pyproject.tomlpointed at theGitHub README. All now use the canonical Pages URL,
https://kitchingroup.cheme.cmu.edu/jaxsr/.pyproject.tomlalso gains a"Web app"entryso the app is reachable from the PyPI sidebar.
HTTPS enforcement enabled on the Pages site (repo setting, not in this diff).
http://kitchingroup.cheme.cmu.edu/jaxsr/now returns 301 tohttps://rather than servingover plain HTTP.
Verification
jupyter-book<2rather than the v2 installed locally,since v2 is a different (mystmd) toolchain and would not have told us anything about what
CI produces. The admonition renders as a real
tipadmonition, both app links resolve asexternal links, and the warning count is unchanged at 57.
grepconfirms nojkitchin.github.ioreference remains anywhere in the repo, and nohttp://reference to the Pages host.http://→ 301 →https://, andhttps://kitchingroup.cheme.cmu.edu/jaxsr/app/→ 200.
🤖 Generated with Claude Code