Stuck on an issue?
Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Where to put structured documentation now?
See original GitHub issueNow removed vscode-client had package.json which included a structured documentation of configuration options. Should we retain this file (possibly in a different place/under a different name)?
Issue Analytics
- State:
- Created 2 years ago
- Comments:13 (9 by maintainers)
Top Results From Across the Web
Creating structured documents in Microsoft Word 2010
A short screencast on how to create structured documents in Microsoft Word 2010 including inserting table of contents and heading structure.
Read more >Add Structured Data To Your How-To Pages | Documentation
Discover how you can add structured data to your how-to pages to make your content eligible for a rich result appearance in Google...
Read more >How to Create a Documentation Structure that Works for ... - K15t
So how do you create and maintain well-structured documentation? This post outlines the detailed steps you should take to ensure that your team...
Read more >Edit document structure with the Content and Tags panels ...
To Enable comment tagging in a PDF, in the Tags panel, choose Tag Annotations from the Options menu. Comments or markups that you...
Read more >Structured documentation: principles and advantages, formats ...
A CMS stores all documents in a central repository. It keeps track of changes and guarantees only one person at a time updates...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I think it is more feasible letting each plugin to publish their own configuration options, since we cannot handle all updates and it could be probably get outdated easily.
I think we could have a
sample-configuration.jsonwith the actual server configuration.Maybe the documentation could be similar to the one we use in https://github.com/spyder-ide/pyls-spyder that describes the keys and sections and which hookspecs use them.