Skip to content

Fix up wiki docs within GitHub#348

Merged
lhawkman27 merged 6 commits into
raft-tech:mainfrom
lhawkman27:26-fix-up-wiki-docs-within-github
Mar 20, 2026
Merged

Fix up wiki docs within GitHub#348
lhawkman27 merged 6 commits into
raft-tech:mainfrom
lhawkman27:26-fix-up-wiki-docs-within-github

Conversation

@lhawkman27
Copy link
Copy Markdown
Collaborator

Summary

  • Fix broken wiki cross-links after page renames (dropped "Chart" suffix, renamed "Sample Data and Demo Dashboards")
  • Update wiki page H1 titles to match their filenames
  • Update screenshots with new images and consistent sizing
  • Fix defaultLegendNamesdefaultLegendName JSON key in frontend code to match backend schema
  • Add complete example and improved TOC to JSON Config Spec wiki page
  • Add pointSize documentation (static and dynamic data-driven) to GeoSet Map Layer wiki
  • Fix markdown table formatting across wiki pages

Focus Score

8/10 — All changes are documentation and wiki-related fixes, with one small bug fix (defaultLegendName key rename) that is directly tied to the documentation updates. The scope is tightly focused on making wiki docs accurate and consistent.

Detailed Summary of Each File Changed

  • wiki/Home.md — Updated page links to use new wiki page names (dropped "Chart" suffix, renamed Sample Dashboards); replaced hero screenshot
  • wiki/Getting-Started.md — Updated "Next Steps" wiki links to match renamed pages
  • wiki/GeoSet-Map-Layer.md — Fixed H1 title, updated cross-links, replaced screenshots, added pointSize section (static & dynamic), expanded pointType icon list, moved pointSize out of globalColoring, fixed table formatting
  • wiki/GeoSet-Multi-Map.md — Fixed H1 title, updated all cross-links to renamed pages, replaced screenshots
  • wiki/Sample-Dashboards.md — Fixed H1 title to "Sample Dashboards", updated screenshots, fixed markdown table alignment
  • wiki/JSON-Config-Spec.md — Added "Complete Example" section with full config sample, restructured TOC with proper nesting, fixed table column alignment
  • superset-frontend/.../GeoSetLayer.tsx — Renamed defaultLegendNamesdefaultLegendName JSON key access to match backend schema
  • superset-frontend/.../transformProps.ts — Same defaultLegendNamesdefaultLegendName key rename

Test Plan

  • Verify wiki pages render correctly on GitHub Wiki after merge (auto-synced via CI)
  • Confirm all [[wiki links]] resolve to the correct pages
  • Verify screenshots display at appropriate sizes
  • Test GeoSet Map Layer chart with colorByCategory config containing defaultLegendName key to ensure legend labels render correctly
  • Test that existing charts without defaultLegendName still fall back to ['Other']

🤖 Generated with Claude Code

lhawkins and others added 5 commits March 13, 2026 12:48
- Fix 9 broken internal wiki links across Home, Getting-Started,
  GeoSet-Map-Layer, and GeoSet-Multi-Map pages (removed "Chart" suffix
  and corrected "Sample Data and Demo Dashboards" to "Sample Dashboards")
- Update wiki screenshots with current UI images
- Fix defaultLegendName/defaultLegendNames mismatch: frontend was reading
  plural "defaultLegendNames" but schema uses singular "defaultLegendName",
  causing the feature to silently not work
- Update GeoSet-Map-Layer.md: move pointSize out of globalColoring (V4),
  add dynamic pointSize docs, update range to 1-200, list all pointType values
- Clarify PR raft-tech#319 TODO note in JSON-Config-Spec.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add a complete example section to the JSON Config Spec wiki page
showing all configuration fields together. Also fix H1 titles in
three wiki pages to match their filenames and cross-link targets.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@lhawkman27 lhawkman27 linked an issue Mar 18, 2026 that may be closed by this pull request
@lhawkman27 lhawkman27 self-assigned this Mar 18, 2026
Copy link
Copy Markdown
Contributor

@ethanbienstock ethanbienstock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lhawkman27 lhawkman27 merged commit 0d6a8fb into raft-tech:main Mar 20, 2026
7 checks passed
@lhawkman27 lhawkman27 deleted the 26-fix-up-wiki-docs-within-github branch April 1, 2026 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Start building out the wiki docs within GitHub

2 participants