Skip to content

Agent documentation#8031

Merged
zurfyx merged 6 commits intomainfrom
docs/reorganize-readme-and-agent-docs
Dec 17, 2025
Merged

Agent documentation#8031
zurfyx merged 6 commits intomainfrom
docs/reorganize-readme-and-agent-docs

Conversation

@zurfyx
Copy link
Copy Markdown
Member

@zurfyx zurfyx commented Dec 16, 2025

We may want to start intentionally incorporating LLMs into the repo for the sake of development velocity. This can be experimental for now but it has played out very well internally so I'm optimistic.

The idea is to be docs first and Claude / others having an easy time identifying the relevant docs. To make this more effective we may also want to be more strict when it comes to documentation for new features, and complex developer pieces in the core, just like we enforce a test per PR now.

@vercel
Copy link
Copy Markdown

vercel bot commented Dec 16, 2025

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

Project Deployment Review Updated (UTC)
lexical Ready Ready Preview, Comment Dec 16, 2025 11:45pm
lexical-playground Ready Ready Preview, Comment Dec 16, 2025 11:45pm

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Dec 16, 2025
- Simplify README.md with clean, user-facing design inspired by Vite

  - Add dark mode support for logo using GitHub fragment syntax

  - Add npm downloads badge

  - Update links to point to lexical.dev/docs

- Create AGENTS.md with comprehensive developer guide

- Simplify CLAUDE.md to minimal pointer

Fixes MDX compilation by using simple img tags with #gh-*-mode-only fragments instead of picture element.
Copy link
Copy Markdown
Collaborator

@etrepum etrepum left a comment

Choose a reason for hiding this comment

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

I wonder if it’s better or worse that our rest API docs are only in docusaurus. Serving agent-appropriate docs seems like functionality it should have

@zurfyx zurfyx added this pull request to the merge queue Dec 17, 2025
Merged via the queue into main with commit 70d958d Dec 17, 2025
39 checks passed
@zurfyx zurfyx deleted the docs/reorganize-readme-and-agent-docs branch December 18, 2025 20:15
@etrepum etrepum mentioned this pull request Jan 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants