Closed janishutz closed 1 year ago
I am currently working on an actual website for impress.js
I still need to work on the table of contents, I forgot about that.
added that
Hey @simplePCBuilding. Thank you for the effort you put into this. I'm skeptical about the structure it introduces regarding plugins. As of now, each plugin is treated separately in its own subdirectory within src/plugins
. Some directories contain only the plain JavaScript file, others also include their own README.md
. I would suggest to stick to this structures as it makes it easy to separate concerns. In the long term, plugins can be easily added as new directories without any additional maintenance burden to keep the global README.md
or GettingStarted.md
consistent. In addition, some might even be pulled out into their own repository. So I would be in favor to just create new README.md
files in the subdirectories of src/plugins
where they are currently missing.
@henrikingo, what's your opinion on this?
Only did this because it was requested in an issue.
You are probably referring to #831. What is the difference between the two pull requests #831 and #835?
@fnogatz thanks for helping out with reviews!
Yes so I have feedback on 2 levels here:
/src/plugins/TableOfContents.md
automatically. (Just like /examples/index.html
is generated.)Sure, I'll do that. I'll probably also clean this branch here with that. I'll just add a simple getting started here.
I have a way better solution for this with the website. I'll add README's to all plugins that don't have any yet
I have solved both your ideas with two different approaches.
I collected documentation for all the plugins and added documentation, where it was still required. I will be adding these to the wiki as well.