Skip to content

Update developer dashboard documentation to reflect recent release/testing framework changes #480

Description

@annakrystalli

Context

Significant changes have landed (and are landing) across the dashboard pipeline's release and testing framework. The developer-facing docs in hubverse-org/hubDocs have not yet been updated to match, and a new contributor following the existing pages would miss several load-bearing concepts.

The changes touch multiple repos and affect overlapping pages, so the right first step is to scope what needs updating where, before anyone writes prose.

High-level changes to reflect (non-exhaustive)

This list is intentionally rough; treat it as input to scoping, not a checklist:

Affected pages (approximate, scoping will refine)

Best-guess starting set, will need confirmation:

  • developer/dashboard-local.md
  • developer/dashboard-workflows.md
  • developer/dashboard-predevals.md
  • developer/dashboard-staging.md
  • developer/dashboard-tools.md

First step: scope

Before writing any prose, decide:

  1. Which concepts above belong on which page (some may need new sections or even new pages).
  2. Which pages need light edits vs. substantial rewrites.
  3. Whether any concepts are better tracked as their own dedicated docs issues that this one links to.
  4. Which changes are still in flight (e.g. the sanity-check workflow on dashboard-test-hub-dashboard) and should be left as TODO links until they land vs. documented as-implemented.

Update this issue body (or open child issues) with the scoped plan, then proceed to writing.

Cross-links

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions