Research Documentation
Read guide [page identifier] in documentation version [version] and summarize its prerequisites and steps.
readme
ReadMe AI Employee
Leina connects to ReadMe to help you find documentation, revise guides, and draft changelogs. Ask in your team chat. Leina does the work and brings back the result.
Connect ReadMe, choose what to share, and hand off your first task.
Leina + ReadMe Example Result
You
Create a hidden changelog titled “Spring update”: saved filters are now available, and export errors have been fixed.
Leina
I created the changelog and kept it hidden for review.
ReadMe · Changelog draft
Spring update
A hidden entry with the release’s changes.
- New
- Save filters to reuse your preferred view.
- Fixed
- Resolved errors when exporting results.
What Is a ReadMe AI Agent?
A ReadMe AI agent can review a guide, apply your revised text, or create a changelog with the visibility you choose.
You specify the source and the destination. Leina uses the content available to your connection and returns the result for you to review.
ReadMe
ReadMe hosts product documentation, API references, and changelogs.
-
Share release notes
Specify the title, changes, and visibility.
-
Create the entry
Save the changelog in ReadMe.
-
Review before publishing
Check the hidden entry before making it public.
What to Ask Leina to Do with ReadMe
Copy a prompt, add your details, and send it to Leina in your connected team chat.
Revise a Guide Page
Read guide [page identifier] in version [version], then replace its text with this complete revision: [text].
readme
Create a Changelog
Create a changelog titled [title] using these release notes [notes]. Keep it [hidden or public].
readme
Your next ReadMe task can start with a message.
Connect. Ask. Get the Result.
Tell Leina what you need in your team chat. Include the source, destination, and expected result.
-
Connect Your Account
Connect the tools involved and give Leina access to the content it needs.
-
Try a Task
Share the source material, say where the result belongs, and describe what you need.
-
Check the Result
Review the result and any changes in the connected app.
Put Leina to Work in ReadMe
Hand off these everyday tasks to your AI employee.
Get Project
Get metadata for the ReadMe project associated with the API key.
List Versions
List the versions configured for the ReadMe project.
Get Version
Get one ReadMe project version by semver identifier.
Create Version
Create a new ReadMe project version from an existing base version.
Update Version
Update one ReadMe project version by semver identifier.
Delete Version
Delete one ReadMe project version by semver identifier.
List Categories
List ReadMe guide and reference categories with optional version and pagination.
Create Category
Create a ReadMe guide or reference category.
Get Category
Get one ReadMe category by slug.
Update Category
Update one ReadMe category by slug.
Delete Category
Delete one ReadMe category by slug.
List Category Docs
List the ReadMe docs that belong to a category slug.
Search Docs
Search ReadMe docs by text query.
Create Doc
Create a ReadMe doc page using a category ID or category slug.
Get Doc
Get one ReadMe doc by slug, optionally requesting the production doc version.
Update Doc
Update one ReadMe doc page by slug.
Delete Doc
Delete one ReadMe doc page by slug.
List Custom Pages
List ReadMe custom pages with optional pagination.
Create Custom Page
Create a ReadMe custom page.
Get Custom Page
Get one ReadMe custom page by slug.
Update Custom Page
Update one ReadMe custom page by slug.
Delete Custom Page
Delete one ReadMe custom page by slug.
List Changelogs
List ReadMe changelog entries with optional pagination.
Create Changelog
Create a ReadMe changelog entry.
Get Changelog
Get one ReadMe changelog entry by slug.
Update Changelog
Update one ReadMe changelog entry by slug.
Delete Changelog
Delete one ReadMe changelog entry by slug.
List Api Specifications
List ReadMe API specification metadata with optional version and pagination.
Delete Api Specification
Delete one ReadMe API specification by ID.
Get Api Registry
Retrieve one ReadMe API Registry entry by UUID.
Get Openapi Schema
Get the OpenAPI definition for the ReadMe project.
List Outbound Ips
List ReadMe outbound IP addresses used for webhook and Try It proxy requests.
Ask Owlbot
Ask ReadMe Owlbot a non-streaming question and return its answer with sources.
More Tools for Your AI Employee
Connect the Apps your work depends on, and give Leina the context to carry the task forward.
Keep the Conversation Moving. Let Leina Pick Up the Work.
Hand off a task while your team is discussing it. Leina uses your connected tools and brings the result back to the conversation.
See How Leina Works in SlackLeinaExample Result I created the changelog and kept it hidden for review.
Spring update
ReadMe + Leina: Your Questions, Answered
Can I choose which documentation version to edit?
Yes. Specify the version with the guide so the edit reaches the intended release.
Does revising a guide append to the old text?
A body update replaces the page text. Include any existing sections you want to keep in the revised version.
Make Leina Your ReadMe AI Employee
Start with one task you already need to do. Tell Leina what a finished result should look like.
Connect ReadMe, choose what to share, and hand off your first task.