Skip to content

docs(lapis): improve landing page, describe lineage queries#1702

Open
chaoran-chen wants to merge 2 commits into
mainfrom
improve-docs
Open

docs(lapis): improve landing page, describe lineage queries#1702
chaoran-chen wants to merge 2 commits into
mainfrom
improve-docs

Conversation

@chaoran-chen

Copy link
Copy Markdown
Member

This is updating the docs, mainly:

  • add content to landing page
  • describe lineage queries
  • describe customizable FASTA headers

PR Checklist

  • [ ] All necessary documentation has been adapted.
  • [ ] All necessary changes are explained in the llms.txt.
  • [ ] The implemented feature is covered by an appropriate test.

@vercel

vercel Bot commented May 23, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
lapis Ready Ready Preview, Comment May 31, 2026 6:53pm

Request Review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates LAPIS documentation to improve the landing page and document two additional concepts (lineage queries and customizable FASTA headers), while aligning Playwright navigation tests with the updated “Get started” entry point.

Changes:

  • Expanded the docs landing page content and updated the primary CTA from “Introduction” to “Get started”.
  • Added new Concept pages: Lineage queries and Customizable FASTA headers, and linked them from existing pages/navigation.
  • Updated docs config parsing/helpers (generateLineageIndex) and adjusted Playwright tests to match the new navigation.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

Show a summary per file
File Description
lapis-docs/tests/queryGenerator.page.ts Updates navigation click target to “Get started” for query generator flow.
lapis-docs/tests/docs.spec.ts Adds new concept pages to expected navigation list and updates entry click to “Get started”.
lapis-docs/tests/configGenerator.page.ts Updates navigation click target to “Get started” for config generator flow.
lapis-docs/src/content/docs/index.mdx Improves landing page copy, updates CTA labeling, and adds “Known instances” + citation content.
lapis-docs/src/content/docs/concepts/response-format.mdx Adds a pointer to the new customizable FASTA headers documentation.
lapis-docs/src/content/docs/concepts/pango-lineage-query.mdx Clarifies availability note and cross-links to generalized lineage queries.
lapis-docs/src/content/docs/concepts/lineage-queries.mdx New page documenting lineage-index wildcard semantics and advanced query usage.
lapis-docs/src/content/docs/concepts/customizable-fasta-headers.mdx New page documenting fastaHeaderTemplate placeholders and encoding examples.
lapis-docs/src/content/docs/concepts/advanced-query.mdx Fixes an example intro sentence to correctly refer to advanced queries.
lapis-docs/src/config.ts Adjusts generateLineageIndex typing/logic and adds hasLineageFields() helper for conditional docs.
lapis-docs/astro.config.mjs Adds the two new Concept pages to the sidebar navigation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread lapis-docs/src/content/docs/concepts/customizable-fasta-headers.mdx Outdated
Comment thread lapis-docs/src/content/docs/concepts/lineage-queries.mdx

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe an example on how the result would look like might also help? (Non blocking, we can also do that in a separate PR)

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