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.

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

Api documentation additions #5

Open
miami78 opened this issue Dec 11, 2019 · 5 comments
Open

Api documentation additions #5

miami78 opened this issue Dec 11, 2019 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@miami78
Copy link
Collaborator

miami78 commented Dec 11, 2019

  • add apiary link in the readme as well as the VSCode extension.
  • explain how people can make modifications to the .apib file
@miami78 miami78 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 11, 2019
@Kenchir
Copy link

Kenchir commented Dec 11, 2019

Hi, I am not getting what is supposed to be done at backend. Maybe someone should note down the deliverables.

@miami78
Copy link
Collaborator Author

miami78 commented Dec 11, 2019

@Kenchir we are working on the readme and contributions.md so as to make it easier for people to contribute, the project scope hasn't been discussed yet that's why we don't have any APIs up or features being worked on right now. We will have a call to verify all that and I will open a couple of issues where all can contribute

@myoungerman
Copy link

@miami78 Is this API documentation a good first project for a beginner? I'm a technical writer who knows some JavaScript, and I want to get some hands-on experience writing REST API documentation.

@MarvinKweyu
Copy link
Member

@VerumEmanio , the documentation has been assigned already, unfortunately.

@miami78
Copy link
Collaborator Author

miami78 commented Dec 19, 2019

@VerumEmanio yes it is but unfortunately this issue was already assigned to someone else,keep checking the issues tab we will be updating new issues soon.....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants