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

feature: Documentation TODOs #30

Open
5 tasks
raamsri opened this issue Jan 5, 2025 · 0 comments
Open
5 tasks

feature: Documentation TODOs #30

raamsri opened this issue Jan 5, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Good to Have Non critical, and not priotirized yet.

Comments

@raamsri
Copy link
Contributor

raamsri commented Jan 5, 2025

Feature Request

Summary

Documentation gaps in core functionality

Motivation

Missing or incomplete documentation for:

  • API endpoints
  • Configuration options
  • Error codes
  • Property descriptions
  • CLI commands

Detailed Design

  1. Documentation Structure:
    • API reference
    • Configuration guide
    • Error handling guide
    • Property reference
    • CLI manual

Acceptance Criteria

  • Complete API documentation
  • Updated configuration examples
  • Error handling guide
  • Property reference guide
  • CLI command documentation
@raamsri raamsri added documentation Improvements or additions to documentation good first issue Good for newcomers Good to Have Non critical, and not priotirized yet. labels Jan 5, 2025
raamsri added a commit that referenced this issue Jan 25, 2025
@raamsri
Include a crude API documentation
575ce21 
Ref: #30

Signed-off-by: Raamsri Kumar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Good to Have Non critical, and not priotirized yet.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@raamsri