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

Create an Auxiliary Module Hierarchy for Category Documentation #1901

Closed
6 tasks done
Tracked by #3067
iamrecursion opened this issue Jul 26, 2021 · 0 comments · Fixed by #1910
Closed
6 tasks done
Tracked by #3067

Create an Auxiliary Module Hierarchy for Category Documentation #1901

iamrecursion opened this issue Jul 26, 2021 · 0 comments · Fixed by #1910
Assignees
Labels
p-highest Should be completed ASAP

Comments

@iamrecursion
Copy link
Contributor

iamrecursion commented Jul 26, 2021

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

  • 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p-highest Should be completed ASAP
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant