You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We need some flexible way to display documentation for the "categories" in the new searcher (#1753). A way to do this that only involves existing machinery is to create an additional library under Standard that contains only documentation.
Value
We have a mechanism for updating the category documentation that is not hard-coded into the IDE, and utilises the existing mechanisms for displaying and rendering documentation.
Specification
Create a new library Standard.Searcher that integrates with the editions system like all other libraries.
Describe the categories that we actually want with a brief blurb about what kind of things are envisioned to go in each. CC @wdanilo for specifying this.
Describe briefly what kinds of examples you want to see in these high level categories.
Implement a hierarchy of modules in this library, mapping spaces in the names to underscores in the module names.
In each of these modules, write comprehensive documentation with examples for what these areas allow you to do.
Acceptance Criteria & Test Cases
We have an auxiliary library that provides the documentation through the standard mechanisms for the new portion of the searcher.
The text was updated successfully, but these errors were encountered:
Summary
We need some flexible way to display documentation for the "categories" in the new searcher (#1753). A way to do this that only involves existing machinery is to create an additional library under
Standard
that contains only documentation.Value
We have a mechanism for updating the category documentation that is not hard-coded into the IDE, and utilises the existing mechanisms for displaying and rendering documentation.
Specification
Standard.Searcher
that integrates with the editions system like all other libraries.Acceptance Criteria & Test Cases
The text was updated successfully, but these errors were encountered: