Skip to content

docs(lapis-docs): improve AGENTS.md#1710

Merged
fengelniederhammer merged 3 commits into
mainfrom
betterDocsAgentsMd
May 27, 2026
Merged

docs(lapis-docs): improve AGENTS.md#1710
fengelniederhammer merged 3 commits into
mainfrom
betterDocsAgentsMd

Conversation

@fengelniederhammer
Copy link
Copy Markdown
Contributor

Make it more focussed: delete some wrong and unnecessary things. Add general assumptions and guidelines.

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
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

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

Project Deployment Actions Updated (UTC)
lapis Ready Ready Preview, Comment May 27, 2026 8:47am

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 refines lapis-docs/AGENTS.md to better focus guidance for AI coding agents working on the LAPIS documentation site, removing overly specific framework examples and adding higher-level assumptions/guidelines about how the docs are intended to be used.

Changes:

  • Added assumptions about docs being instance-specific (deployed alongside a running LAPIS instance) and about using real field names in examples.
  • Introduced a content categorization guideline (Tutorials / How-To Guides / References).
  • Simplified development workflow guidance (e.g., paths, component guidance) and condensed production notes.

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

Comment thread lapis-docs/AGENTS.md Outdated
Comment thread lapis-docs/AGENTS.md Outdated
Comment thread lapis-docs/AGENTS.md
Make it more focussed: delete some wrong and unnecessary things. Add general assumptions and guidelines.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

Comment thread lapis-docs/AGENTS.md
@fengelniederhammer fengelniederhammer merged commit fc0d560 into main May 27, 2026
8 checks passed
@fengelniederhammer fengelniederhammer deleted the betterDocsAgentsMd branch May 27, 2026 09:42
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