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

Documenting commands to be view or window specific. #5

Open
Ultra-Instinct-05 opened this issue Mar 22, 2020 · 1 comment
Open

Documenting commands to be view or window specific. #5

Ultra-Instinct-05 opened this issue Mar 22, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Ultra-Instinct-05
Copy link
Contributor

This had been raised in guillermooo/sublime-undocs#273.
@FichteFoll If you could give an example on how you would like to see this being documented, I can take a shot at completing it.

@FichteFoll
Copy link
Member

This will need a more carefully laid-out plan as it is hugely impactful, but my general idea is to base documentation for commands on a scraped document from the sigantures and docstrings of the default packages and combine that with the manual documentation of shipped commands as we already do for PackageDev and then build the resulting HTML based on that. This prodecure would already have all the necessary meta information available. Areas of concern would be on how to update the document from changes to the default packages and I am currently imagining a multi-layered process where we can inject updated information in a position that allows automatic replacement of entire files, making the updating process rather painless.

Currently, we are in a very early phase of drafting and experimenting with how to move forward with the docs regarding design, build pipeline and markup language, so I would suggest against doing large-effort changes to the current state of affairs and instead contribute in the issues that we are going to create and discuss in over the next few week(s) (hopefully singular).

@TerminalFi TerminalFi added the documentation Improvements or additions to documentation label Apr 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants