Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs #308

Open
rmarescu opened this issue Feb 3, 2025 · 2 comments
Open

Docs #308

rmarescu opened this issue Feb 3, 2025 · 2 comments
Milestone
v0.4.5

Comments

@rmarescu
Copy link
Member

rmarescu commented Feb 3, 2025 •
edited
Loading

What

  • CLI
  • API
  • guides

Auto-generated via code comments where possible, or using AI

Why

  • Improve DX of using Shortest
  • Share with and get help from AI on integrating Shortest on other projects.

Example

No response
@rmarescu rmarescu added this to Shortest Feb 3, 2025
@rmarescu rmarescu moved this to Scoping needed in Shortest Feb 3, 2025
@rmarescu rmarescu added this to the v0.4.5 milestone Feb 3, 2025
@slavingia
Copy link
Contributor

IMO README should suffice?

@rmarescu
Copy link
Member Author

That could work, if it doesn't clutter the file too much.

Ideally, I'm looking for a way to say Write Shortest for auth @Docs > Shortest in Cursor composer, so that the AI knows what Shortest can do, and how to write the tests.

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Shortest
Status: Scoping needed
Milestone
v0.4.5
Development

No branches or pull requests
2 participants
@slavingia @rmarescu