docs: add product roadmap#9
Merged
Merged
Conversation
PR Summary by Qododocs: add public product roadmap
AI Description
High-Level Assessment
Files changed (1)
|
Code Review by Qodo
1. Roadmap not linked
|
Comment on lines
+1
to
+3
| # agentling roadmap | ||
|
|
||
| agentling is a tiny async framework for reliable, observable, tool-using agents: |
There was a problem hiding this comment.
1. Roadmap not linked 🐞 Bug ⚙ Maintainability
ROADMAP.md is added but the project’s README (the primary landing page) doesn’t link to it, so most users won’t discover the roadmap unless they browse the repo file list directly. This is a low-severity documentation/navigation gap.
Agent Prompt
## Issue description
A new `ROADMAP.md` is introduced, but `README.md` doesn’t reference it. This makes the roadmap hard to discover for users who primarily read the README.
## Issue Context
`README.md` contains a "Contents" section but no "Roadmap" entry/link.
## Fix Focus Areas
- README.md[44-62]
- ROADMAP.md[1-3]
## Suggested fix
- Add a "Roadmap" bullet/link in `README.md` (either near the top description or in the Contents list), pointing to `ROADMAP.md`.
- (Optional) Add a `Roadmap = ".../ROADMAP.md"` entry under `[project.urls]` in `pyproject.toml` if you want it visible on package indexes.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Public, directional roadmap: Reliability, then Observability, then more models.