Skip to content

Apply the Dx theme and copy pass to the docs site #149

Closed

Description

@wallstop

03 · Documentation site theme and copy pass

Parent: #146 (Epic: Rebrand Data Visualizer as DxVisualizer)
Labels: documentation

Summary

Replace the default Material look with the Dx theme, restructure the nav, apply
the copy pass, and add three pages. All files are written in
production/repo/.

Tasks

  • Replace mkdocs.yml with production/repo/mkdocs.yml.
  • Add docs/stylesheets/extra.css and docs/overrides/home.html.
  • Replace docs/index.md, getting-started.md, search-and-filter.md,
    managing-assets.md, organizing.md, extending.md.
  • Add docs/migration.md, docs/troubleshooting.md, docs/roadmap.md.
  • Add to docs/images/: dxvisualizer-mark.svg, favicon-32.png,
    dxvisualizer-banner.png (from production/repo/docs/images/).
  • Replace README.md and CHANGELOG.md with the production/repo/
    versions; on release, move [Unreleased] to [0.2.0].
  • Run scripts/build-docs.ps1 locally; fix anything strict mode reports.

What changed in the copy

  • Product name in prose; code identifiers untouched.
  • Repository and site URLs point at Ambiguous-Interactive/DxVisualizer.
  • Menu paths updated to DxVisualizer.
  • Getting started: row actions described as the four buttons on each row, not
    "above the object list" (see INCONSISTENCIES.md I-04).
  • Organizing: six themes with Dx first; Reset Theme lands on Dx; new theme
    asset menu path; Dx.uss added as a palette reference.
  • Extending: a note that namespaces keep the DataVisualizer name.
  • README: concise, PNG banner, AI and alpha notes as one plain line each, links
    into the site.

Acceptance criteria

  • Strict build passes; no broken links or nav omissions.
  • Home renders the hero, trust strip, three cards, then index.md.
  • Dark is the default; the toggle switches to Press paper.
  • Active nav item is a contained pill; admonitions have no left accent bar.
  • Light-mode text and links meet 4.5:1 (#2a64c4 on #f4f1ea is 5.0:1).
  • The README banner renders on GitHub and on the npm page.

Notes

  • overrides/ is in exclude_docs so templates are not published as files.
  • The homepage hero uses images/data-visualizer-layout.png until issue 06
    recaptures it in Dx; the template has a comment where to swap it.

Activity

  1. wallstop commented on Oct 10, 2026

    @wallstop
    OwnerAuthor

    DISCLOSURE: LLM-GENERATED TEXT

    Delivered the copy-pass slice in PR #164 against the current site (no handoff files exist in this repository, so the theme/nav restructure and the three new pages could not be transplanted and remain open):

    • Product name in prose across the site and README; code identifiers untouched, as this task specifies.
    • Menu paths match the code: Tools → Wallstop Studios → DxVisualizer and Assets → Create → Wallstop Studios → DxVisualizer → DxVisualizer Theme.
    • Getting started describes the row actions as the four buttons on each row (I-04).
    • Extending gains the note that namespaces and types keep the DataVisualizer name.
    • Persistence copy uses the on-screen Persist State in Settings Asset label with the default off (I-03, recorded in Resolve documentation inconsistencies against the code #153).

    Repository and site URLs still point at wallstop/... on purpose: the move is #151, and repointing them before the move would 404 every link. Image recaptures stay with #152, so capture alt text still names the old window.

  2. wallstop commented on Oct 10, 2026

    @wallstop
    OwnerAuthor

    DISCLOSURE: LLM-GENERATED TEXT

    Theme slice delivered in PR #165, on top of the copy pass from #164:

    • mkdocs.yml: site renamed to DxVisualizer, palette reordered so ink dark is the server-rendered default with a light toggle (Material renders the first palette entry as the default), custom_dir and extra_css wired, overrides/ excluded from the published site.
    • docs/stylesheets/extra.css: the Dx palette from Dx.uss — ink surfaces, azure accent, and the paper light scheme (#f4f1ea ground, #2a64c4 links at 5.0:1), pill-shaped active nav entries, admonitions carrying a full border instead of the left accent bar.
    • docs/overrides/home.html: hero capture, free-forever trust strip, three section cards, then the index content; index.md selects it via template: home.html front matter and drops its now-duplicated inline image.

    Also corrected the theme copy that still predated the Dx default: organizing.md and the README now list six themes with Dx first, describe Dx (ink surfaces, azure accent), and name Dx as the Reset Theme target; Dx.uss joins Nord and Dracula as named palette references.

    Still open on this issue: the nav restructure and the migration/roadmap pages. The handoff files this issue assumed never existed in this repository, so the theme was authored in-repo from Dx.uss rather than transplanted; the remaining pages should follow the same in-repo path.

  3. wallstop commented on Oct 10, 2026

    @wallstop
    OwnerAuthor

    DISCLOSURE: LLM-GENERATED TEXT

    Delivered the remaining slices in PR #167:

    • docs/migration.md: updating a pre-rename install through Package Manager, what changes on screen (Tools → Wallstop Studios → DxVisualizer, create menu DxVisualizer Settings/Theme — both verified against the code's menu attributes), and what deliberately does not: the WallstopStudios.DataVisualizer namespaces and type names, saved state in both persistence modes, asset file names, and the com.wallstop-studios.data-visualizer package identity. The install URL stays wallstop/... until Move the repository and GitHub Pages to Ambiguous-Interactive/DxVisualizer #151 lands, which the page states.
    • docs/roadmap.md: shipped / in progress / under-contract sections linking the tracked issues (the system of record) instead of duplicating them.
    • mkdocs.yml nav grouped into Guide and Help sections; index.md links both pages. Strict build green; built site renders both groups and both pages.

    With #164 (copy pass), #165 (theme + hero), and the favicon/banner from #168, every task and acceptance criterion on this issue is covered — ready to close when the PRs merge.

  4. wallstop commented on Oct 10, 2026

    @wallstop
    OwnerAuthor

    DISCLOSURE: LLM-GENERATED TEXT

    Correction to the earlier comment on this issue: the planning kit attached to #146 does exist and contains the designed docs system, so PR #167 (top layer of stack #169) adopts the kit's own files instead of a hand translation: mkdocs.yml with the designed nav, fonts, and per-scheme palettes; extra.css; the homepage template; and the kit's Migration and Roadmap pages. Deviations from the kit, all deliberate:

    With #164, #165, and the brand set in #168, every task and acceptance criterion on this issue is delivered; ready to close when the stack merges.

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

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions