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] Add API References to complete the documentation website #15

Closed
mahabubx7 opened this issue Oct 19, 2024 · 1 comment · Fixed by #17
Closed

[Docs] Add API References to complete the documentation website #15

mahabubx7 opened this issue Oct 19, 2024 · 1 comment · Fixed by #17
Assignees
@mahabubx7
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@mahabubx7
Copy link
Owner

[Documentation] Add API References to complete the documentation website

Go to ./docs folder and run the application. Make sure it set up correctly and look around our lib/schemas & lib/validators.
After study, you can start implement the documentation here for each listed pages at docs/api/*.md files.

You must follow the CONTRIBUTING.md guide and open a pull request to the main branch.

Remember, this sprint/ticket/card/task is only for writing the documentation for API References. Not more, not less.

For any query or questions, plz contact me.
~/mahabub/contact
@mahabubx7 mahabubx7 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 19, 2024
@mahabubx7 mahabubx7 changed the title [Documentation] Add API References to complete the documentation website [Docs] Add API References to complete the documentation website Oct 19, 2024
@mahabubx7 mahabubx7 self-assigned this Oct 20, 2024
@mahabubx7
Copy link
Owner Author

Array and Object API references are complete for v1.0.3 (upcoming)

mahabubx7 added a commit that referenced this issue Oct 20, 2024
@mahabubx7
docs(api): #15 complete
3711924
@mahabubx7 mahabubx7 mentioned this issue Oct 20, 2024
Merged
@mahabubx7 mahabubx7 linked a pull request Oct 20, 2024 that will close this issue
feat: #15 docs are complete #17
Merged
mahabubx7 added a commit that referenced this issue Oct 20, 2024
@mahabubx7
Merge pull request #17 from mahabubx7/15-docs-api-ref
2952c86 
feat: #15 docs are complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mahabubx7 mahabubx7

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: #15 docs are complete mahabubx7/akar
1 participant
@mahabubx7