Rewrite public About pages into code-accurate first-time user help - #1
Merged
Merged
Conversation
Co-authored-by: s-t-h <23210341+s-t-h@users.noreply.github.com>
Co-authored-by: s-t-h <23210341+s-t-h@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
s-t-h
August 21, 2026 23:26
View session
s-t-h
marked this pull request as ready for review
August 21, 2026 23:29
There was a problem hiding this comment.
Pull request overview
This PR updates the public About/help content to replace placeholder text with user-facing guidance that matches the app’s implemented behavior (inputs, workflow, results terminology, export/restore tooling, and repository-verifiable legal/cookie/session details).
Changes:
- Rewrote the Usage page into an end-to-end workflow guide, including validated FASTA/GFF constraints, rate limiting, session/export tools, and request-size limits.
- Replaced the Results/Descriptions page with concise definitions of UI terms/fields (e.g.,
top1/top2/top3,P(top*), nearest-neighbor fields) and how linked views behave. - Simplified Contact/Citation and rebuilt Legal/Privacy text around repository-backed cookie/session and license details, with explicit TODOs for deployment-specific legal requirements.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| app/phagegap/templates/about/usage.html | Replaces lorem ipsum with a step-by-step usage guide aligned to implemented submission, GFF, rate-limit, and export/restore behavior. |
| app/phagegap/templates/about/descriptions.html | Defines UI results terms and fields used by the app, including landscape, nearest-neighbor, structure, and genomic-context concepts. |
| app/phagegap/templates/about/contact.html | Streamlines contact and citation details, keeping repository link prominent and formatting headings consistently within the About index. |
| app/phagegap/templates/about/legal.html | Replaces generic boilerplate with repository-verifiable license/cookie/session behavior plus deployment-specific legal TODOs. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
This PR replaces placeholder/misaligned About content with concise, user-facing guidance derived from actual
/app/phagegapbehavior. It focuses the four public help pages on real input rules, workflow, result interpretation, and repository-verifiable legal/contact information.Usage page (
usage.html).json.gzexport/reload, and screenshot.Result interpretation page (
descriptions.html)Global Embedding Landscape,User Data, nearest-neighbor link,top1/top2/top3,P(top*), and neighbor distance.Contact page (
contact.html)Legal page (
legal.html)