Skip to content
This repository has been archived by the owner on Jul 31, 2024. It is now read-only.

Add API documentation to README #23

Closed
fraxken opened this issue Mar 22, 2023 · 2 comments
Closed

Add API documentation to README #23

fraxken opened this issue Mar 22, 2023 · 2 comments
Assignees
@fabnguess
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@fraxken
Copy link
Member

fraxken commented Mar 22, 2023

Hello 👋

The goal of the task is to add API documentation to the README. Current API is a bit obscure and can be quite complicated to understand at first look.

Example of API documentation can be found in another project like RC.
@fraxken fraxken added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 22, 2023
@manan1979
Copy link

hi @fraxken can u guide me how do i add API documentation to the readme

@fraxken
Copy link
Member Author

fraxken commented Mar 25, 2023

@manan1979 It's equivalent to writing documentation, so it required to look at the code. You need to have some understading of markdown. For how to do it exactly, that's why I linked an "example" project.

Can't help that much, if you have more precise questions do not hesitate

@fabnguess fabnguess self-assigned this Aug 16, 2023
@fabnguess fabnguess mentioned this issue Aug 16, 2023
Closed
@fraxken fraxken closed this as completed Aug 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@fabnguess fabnguess

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.

Add API documentation to README NodeSecure/domain-check
3 participants
@fraxken @fabnguess @manan1979