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

Write comprehensive docs #52

Open
parzhitsky opened this issue Feb 7, 2020 · 0 comments
Open

Write comprehensive docs #52

parzhitsky opened this issue Feb 7, 2020 · 0 comments
Labels
Change: patch [Issue / PR] describes a small non-breaking change, such as bugfix or an optimization Domain: main [Issue / PR] describes change in the functionality, its optimization good first issue [Issue] can be addressed by a first-time contributor Pending: unclear [Issue] not yet fully defined Priority: low [Issue / PR] could be addressed at any convenient time Type: improvement [Issue / PR] addresses lack of a functionality or an open possibility of enhancement

Comments

@parzhitsky
Copy link
Member

  • write docs in docs/ folder
  • host GitHub pages on this folder
  • exclude this folder in .npmignore
@parzhitsky parzhitsky added Change: patch [Issue / PR] describes a small non-breaking change, such as bugfix or an optimization good first issue [Issue] can be addressed by a first-time contributor Domain: main [Issue / PR] describes change in the functionality, its optimization Pending: unclear [Issue] not yet fully defined Priority: medium [Issue / PR] should be addressed without delay Type: improvement [Issue / PR] addresses lack of a functionality or an open possibility of enhancement Priority: low [Issue / PR] could be addressed at any convenient time and removed Priority: medium [Issue / PR] should be addressed without delay labels Feb 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Change: patch [Issue / PR] describes a small non-breaking change, such as bugfix or an optimization Domain: main [Issue / PR] describes change in the functionality, its optimization good first issue [Issue] can be addressed by a first-time contributor Pending: unclear [Issue] not yet fully defined Priority: low [Issue / PR] could be addressed at any convenient time Type: improvement [Issue / PR] addresses lack of a functionality or an open possibility of enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@parzhitsky