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

(Automated) Documentation #139

Closed
kordwarshuis opened this issue Apr 4, 2024 · 3 comments
Closed

(Automated) Documentation #139

kordwarshuis opened this issue Apr 4, 2024 · 3 comments
Assignees
@kordwarshuis

Comments

@kordwarshuis
Copy link
Collaborator

kordwarshuis commented Apr 4, 2024 •
edited
Loading

What strategies to follow when creating code documentation.
@kordwarshuis
Copy link
Collaborator Author

  • The dynamic nature of JavaScript makes it hard for auto-generation tools to reliably analyze all code paths and dependencies.
  • Node projects often use a lot of module imports, async flows, event emitters etc which can be tricky for tools to follow.
  • Auto-generated diagrams often end up being too complex or detailed to be useful.

@henkvancann
Copy link
Collaborator

  • To do Kor: document the data-level in the article tag, how does it get there, how persistent is it, what is its use and benefit.

@henkvancann henkvancann changed the title Automated documentation (Automated) Documentation Apr 18, 2024
@henkvancann henkvancann mentioned this issue Aug 5, 2024
Closed
@kordwarshuis kordwarshuis mentioned this issue Aug 19, 2024
Open
@kordwarshuis kordwarshuis self-assigned this Aug 26, 2024
@kordwarshuis kordwarshuis modified the milestone: Prio2 Aug 26, 2024
@kordwarshuis
Copy link
Collaborator Author

Will be handled in #188
Close

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kordwarshuis kordwarshuis

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@henkvancann @kordwarshuis