Currently the current documentation has been curated and isn't 100% accurate with upstream documentation. As it stands, current directive documentation relies on the main section document which has subfields for directives and directive options. One needs to assess the generalized structure of existing documentation and transform it into a markdown format that can achieve the hover/autocomplete documentation, section documentation, and option fields autocomplete/hover documentation. This would involve an overhaul to how documentation is handled and as part of it it would make sense to remove any residual unused documentation previously retrieved manually.
Requirements:
- completely automated/codified syncing process for documentation.
- transform documentation from html -> markdown with the regex matching options/directives follow on their respective section documents.
- reference official hosted manual pages for syncing.
- remove residual curated contents.
- verify complete coverage of documentation and limited number of regressions.
- use git/version control for modification of synced documentations
Bonus:
- Update linting features to rely on this syncing process if feasible (this can be a stretch goal if it is difficult to implement)
Currently the current documentation has been curated and isn't 100% accurate with upstream documentation. As it stands, current directive documentation relies on the main section document which has subfields for directives and directive options. One needs to assess the generalized structure of existing documentation and transform it into a markdown format that can achieve the hover/autocomplete documentation, section documentation, and option fields autocomplete/hover documentation. This would involve an overhaul to how documentation is handled and as part of it it would make sense to remove any residual unused documentation previously retrieved manually.
Requirements:
Bonus: