Skip to content

Rewrite public About pages into code-accurate first-time user help - #1

Merged
s-t-h merged 2 commits into
mainfrom
copilot/update-about-help-pages
Aug 21, 2026
Merged

s-t-h merged 2 commits into
mainfrom
copilot/update-about-help-pages

Conversation

Copilot AI commented Aug 21, 2026

Copy link
Copy Markdown

This PR replaces placeholder/misaligned About content with concise, user-facing guidance derived from actual /app/phagegap behavior. It focuses the four public help pages on real input rules, workflow, result interpretation, and repository-verifiable legal/contact information.

  • Usage page (usage.html)

    • Rebuilt as an end-to-end “How to use PhageGAP” flow: FASTA input → run classification → explore linked views → optional GFF context → export/restore.
    • Documents actual constraints from code: FASTA parsing expectations, ID semantics, combined text+file submission, duplicate ID behavior, rate-limit caveat, and request-size caveat.
    • Covers implemented toolbar actions only: results TSV export, session .json.gz export/reload, and screenshot.
  • Result interpretation page (descriptions.html)

    • Replaced lorem text with concise definitions of what users see: Global Embedding Landscape, User Data, nearest-neighbor link, top1/top2/top3, P(top*), and neighbor distance.
    • Added practical interpretation for sequence alignment, structure panel, and genomic context overlays.
    • Preserved UI vocabulary and category names exactly as implemented.
  • Contact page (contact.html)

    • Reduced to authoritative repository-backed contact/maintenance details.
    • Kept citation content concise and reinstated explicit GitHub source URL for citation usability.
  • Legal page (legal.html)

    • Removed speculative/legal boilerplate not grounded in repository behavior.
    • Added neutral, code-verifiable statements on license, cookie/session usage, and repository-scope data handling.
    • Added explicit HTML TODOs for deployment-specific legal/impressum/privacy fields that cannot be inferred safely from code.
<!-- TODO: Add legally required provider/impressum details (responsible entity, address, and official contact channel). -->
<!-- TODO: Add deployment-specific privacy details (hosting provider, log retention, and any external processors), if applicable. -->

Copilot AI and others added 2 commits August 21, 2026 23:12
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>
@s-t-h
s-t-h marked this pull request as ready for review August 21, 2026 23:29
Copilot AI lite review requested due to automatic review settings August 21, 2026 23:29
@s-t-h
s-t-h merged commit b4a627c into main Aug 21, 2026
1 check passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@s-t-h
s-t-h deleted the copilot/update-about-help-pages branch September 29, 2026 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants