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

Autodocs added #395

Closed
wants to merge 10 commits into from
Closed

Autodocs added #395

wants to merge 10 commits into from

Conversation

SenjeyB
Copy link
Contributor

@SenjeyB SenjeyB commented Nov 26, 2024

Added an automatic documantation generator.

@yegor256
Copy link
Member

@SenjeyB thanks for your contribution, but it's better to maintain the structure of JS files that already exists in this repo. See, how commands are dispatched from the eoc.js file. Your command should be docs. I should be able to run eoc docs to generate documentation. Maybe you can create the first PR with a blank implementation of the command -- it will not generate any documentation, but will work and tests will pass. Then, you continue in the second PR, and so on.

@yegor256
Copy link
Member

@maxonfjvipon please take a look

@yegor256
Copy link
Member

@SenjeyB many thanks for your contribution! I see the following issues:

  1. keeping CSS inside JS is not a good idea, better keep it outside as a .css file (or even LESS or SASS)

  2. rendering HTML as a text is not a good idea, better use XSLT

  3. making such a big pull request may lead to much longer review cycles. Better send a shorter change, which will be easier to merge. Later, send improvements and refinements. Check this out: https://www.yegor256.com/2010/03/04/pdd.html

@SenjeyB SenjeyB closed this Dec 3, 2024
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

Successfully merging this pull request may close these issues.

2 participants