Project README
Published February 28, 2026 · Last updated March 5, 2026 · 2 min read
Every Obvious project gets a README — a living summary of what the project is about, what's been done, and where things stand. The agent reads it at the start of every conversation, so a good README means less repeating yourself and faster, more relevant responses.
What the README contains
Obvious generates a README automatically when you create a project. It includes the project's status and purpose, its key artifacts with descriptions, a breakdown of completed and in-progress work, and navigation guidance for collaborators.
View the README
Open the project context pane on the left side of your workspace. Look for the Project Summary card. Click it to expand the full README.
Edit the README through the agent
The quickest way to update the README: ask the agent.
Update the README to mention that we've finished the Q4 analysis
The agent rewrites the relevant sections while preserving the overall structure. This is useful when the automatic update hasn't captured a milestone or when you want to emphasize something specific.
How the agent uses the README
The README is injected into the agent's context at the start of every conversation, allowing the agent to understand the project's purpose, artifacts, and progress. This helps it answer questions like "where are we?" without scanning all artifacts.
Tips for a useful README
Let it evolve. Don't try to write the perfect README upfront; it fills in automatically as you work.
Correct it when it's wrong. If the agent summarized something inaccurately, tell it, as the README is a living document.
<details> <summary>For developers</summary>The README is stored as a project-scoped memory file and indexed for semantic search. You can read or update it programmatically via the project context API.
</details>Next Steps
Key Concepts — Understand how projects, workbooks, documents, and agents fit together.
Personalization Settings — Configure custom instructions that shape how the agent works across all your projects.
Working with the Agent — Get better results with more effective prompts and workflows.