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.

Sign up for GitHub

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

Jump to bottom

Documentation site overhaul #425

Closed
gwhitney opened this issue Aug 28, 2024 · 3 comments
Closed

Documentation site overhaul #425

gwhitney opened this issue Aug 28, 2024 · 3 comments
Assignees
@gwhitney
Labels
documentation Improvements or additions to documentation
Milestone
Alpha v0.5: ui2 ...

Comments

@gwhitney
Copy link
Collaborator

The second PR disrupted the styling of the documentation pages; we need to get them to correspond to the overall styling of the app again.

Originally posted by @gwhitney in https://github.com/numberscope/admin/discussions/6#discussioncomment-9886650
@gwhitney
Copy link
Collaborator Author

This should also encompass #320, #319, #221, #179, #46.

@gwhitney gwhitney added the documentation Improvements or additions to documentation label Aug 28, 2024
@gwhitney
Copy link
Collaborator Author

Kate points out "the doc file behind-the-scenes.md is probably out of date after delft".

@gwhitney gwhitney self-assigned this Nov 1, 2024
gwhitney added a commit to gwhitney/frontscope that referenced this issue Nov 6, 2024
@gwhitney
doc: Update visualizer "Behind the scenes" documentation and move int…
fe02dee 
…o source

   This commit updates the documentation of the VisualizerInterface,
   ParamableInterface, and Paramable base class, and relocates this
   documentation alongside the respective source code for ease of future
   maintenance. It also adds documentation for ParamType and ParamInterface.
   Resolves
   numberscope#425 (comment)
@gwhitney gwhitney mentioned this issue Nov 8, 2024
Merged
katestange pushed a commit that referenced this issue Nov 14, 2024
@gwhitney
Documentation site overhaul for alpha (#486)
e16077b 
* doc: Harmonize docsite style with Numberscope

* refactor: call checkParameters() when sequence changes

   Since checkParameters() is allowed to query the sequence, for
   consistency it must be called again when the sequence changes.

   Also updates the documentation on the "Building a Visualizer" page,
   adding an extensive lifecycle diagram that hopefully will clarify
   what happens when as a visualizer operates.

   Resolves #487.

* doc: Harmonize link styles with frontscope

* doc: Misc improvements
  * Admonition to be sure to clean up state in setup()
  * More thorough vetting of new versions in production in server admin page
  * Typos

  Resolves #319.

* doc: Update visualizer "Behind the scenes" documentation and move into source
   This commit updates the documentation of the VisualizerInterface,
   ParamableInterface, and Paramable base class, and relocates this
   documentation alongside the respective source code for ease of future
   maintenance. It also adds documentation for ParamType and ParamInterface.
   Resolves
   #425 (comment)

* doc: Split making-a-visualizer documentation as recommended

* doc: Convert diagrams to d2 and add more detail

* test: install d2 in GitHub workflows

* doc: Document INVALID_COLOR

* doc: User-guide documentation for the Sequence classes.
  These pages will be needed for #321.

* doc: fix unvisited link color in left sidebar

* doc: typo fixes etc per review

* doc: top-level page organization

* ui: Logo -> About, visualizer/sequence/documentation -> Help

* chore: update GitHub CI snapshots for new NavBar

* doc: Adjustments to NavBar per conversation

* doc: Hone Help menu further, crop sequence page images

* doc: Further revisions of lifecycle diagram as requested

* ui: Further refinements to controls, links, and popups as discussed

* doc: two tiny fixes per review

* doc: improve contributors table in about.md

* doc: add missing parens in lifecycle legend
@gwhitney
Copy link
Collaborator Author

Associated PR merged; closing.

gwhitney added a commit that referenced this issue Jan 20, 2025
@gwhitney
Documentation site overhaul for alpha (#486)
33343b3 
* doc: Harmonize docsite style with Numberscope

* refactor: call checkParameters() when sequence changes

   Since checkParameters() is allowed to query the sequence, for
   consistency it must be called again when the sequence changes.

   Also updates the documentation on the "Building a Visualizer" page,
   adding an extensive lifecycle diagram that hopefully will clarify
   what happens when as a visualizer operates.

   Resolves #487.

* doc: Harmonize link styles with frontscope

* doc: Misc improvements
  * Admonition to be sure to clean up state in setup()
  * More thorough vetting of new versions in production in server admin page
  * Typos

  Resolves #319.

* doc: Update visualizer "Behind the scenes" documentation and move into source
   This commit updates the documentation of the VisualizerInterface,
   ParamableInterface, and Paramable base class, and relocates this
   documentation alongside the respective source code for ease of future
   maintenance. It also adds documentation for ParamType and ParamInterface.
   Resolves
   #425 (comment)

* doc: Split making-a-visualizer documentation as recommended

* doc: Convert diagrams to d2 and add more detail

* test: install d2 in GitHub workflows

* doc: Document INVALID_COLOR

* doc: User-guide documentation for the Sequence classes.
  These pages will be needed for #321.

* doc: fix unvisited link color in left sidebar

* doc: typo fixes etc per review

* doc: top-level page organization

* ui: Logo -> About, visualizer/sequence/documentation -> Help

* chore: update GitHub CI snapshots for new NavBar

* doc: Adjustments to NavBar per conversation

* doc: Hone Help menu further, crop sequence page images

* doc: Further revisions of lifecycle diagram as requested

* ui: Further refinements to controls, links, and popups as discussed

* doc: two tiny fixes per review

* doc: improve contributors table in about.md

* doc: add missing parens in lifecycle legend
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gwhitney gwhitney

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Alpha v0.5: ui2 -> main & deploy
Development

No branches or pull requests
1 participant
@gwhitney