Objective
Currently, there is minimal instruction or documentation available to users. Some basic functionality/UI elements are generic and apply to all applications; other instruction might be application-specific
Initial Implementation Requirements
- Determine what elements/functionality need to be documented
- Determine which parts of the documentation are application-specific and cannot be described generically
- Define a structure for writing documentation; a directory of Markdown might be easier to maintain than YAML or JSON specs
- Define a method for building/rendering documentation in the web UI; this could just render HTML and return it to the front-end, similar to how persona specs are passed
Other Considerations
- An application-specific example is implemented in this commit
- Consider if documentation structure can be specified universally, or if it should be configured per-application. Consider something like mkdocs ( https://github.com/neongeckocom/neon-docs uses this)
- Some things may be more easily maintained as tooltips vs. separate documentation
- Consider maintainability; if documentation is independent of code, it tends to become outdated as code changes without updates to docs
Objective
Currently, there is minimal instruction or documentation available to users. Some basic functionality/UI elements are generic and apply to all applications; other instruction might be application-specific
Initial Implementation Requirements
Other Considerations