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

Writing Documentations :) #7

Open
pouyakary opened this issue Jul 16, 2021 · 0 comments
Open

Writing Documentations :) #7

pouyakary opened this issue Jul 16, 2021 · 0 comments
Assignees
@pouyakary
Labels
State: Todo The issue is still in the todo list Type: Problem Something isn't working
Milestone
Version 1

Comments

@pouyakary
Copy link
Owner

This thing really needs documentations :)

What to do first:

  1. Have JSDoc comments for the methods and attributes of all the important Protocols and Views.
  2. Have a TypeDoc website running that serves the latest types
  3. Have a documentation that explains the views, their constructions and the main ideas: What is the baseline, what is the ViewProtocol, what is the style renderer, etc...
@pouyakary pouyakary added Type: Problem Something isn't working State: Todo The issue is still in the todo list labels Jul 16, 2021
@pouyakary pouyakary added this to the Version 1 milestone Jul 16, 2021
@pouyakary pouyakary self-assigned this Jul 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pouyakary pouyakary

Labels
State: Todo The issue is still in the todo list Type: Problem Something isn't working
Projects
None yet
Milestone
Version 1
Development

No branches or pull requests
1 participant
@pouyakary