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

Document code structure and implementation #31

Open
waldyrious opened this issue Nov 24, 2023 · 0 comments
Open

Document code structure and implementation #31

waldyrious opened this issue Nov 24, 2023 · 0 comments

Comments

@waldyrious
Copy link

This is similar to #4, but instead of describing just the goals and motivation of the project (the "what" and "why"), this issue focuses on the "how".

Specifically, it would be nice to have an overview of that the code does and how it works. This documentation could live in README.md or in CONTRIBUTING.md (or both). I would expect at least a link to https://github.com/bobheadxi/readable/blob/main/plugins/readable/reflow.ts, which, if I understand correctly, is core of the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant