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

Add documentation to project #46

Open
BePo65 opened this issue Feb 25, 2025 · 1 comment
Open

Add documentation to project #46

BePo65 opened this issue Feb 25, 2025 · 1 comment

Comments

@BePo65
Copy link
Contributor

BePo65 commented Feb 25, 2025

Today there is only a (very) short description of esday in the readme file. As the number of plugins increases, a more detailed documentation will be needed.

There are several ways to organize this documentation:

  1. with docu files in the folder of the plugin (this way, all files are in 1 place)
  2. in a docs directory in the project root (the test files are organized this way)
  3. in a separate project (the way that dayjs organizes the documentation)

The documentation could be e.g. in the form of html or markdown files.

I would prefer variant 2 (docs directory) with markdown files.
The markdown files can easily be read in the github web page and can be converted to html and published to github pages in a github action.

@g-mero
Copy link
Owner

g-mero commented Mar 9, 2025

I agree with you.

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

2 participants