Skip to content

docs: pulls out variables into separate page - #425

Merged
lukegalbraithrussell merged 2 commits into
mainfrom
docs-variables-separate-page
Apr 3, 2025
Merged

docs: pulls out variables into separate page#425
lukegalbraithrussell merged 2 commits into
mainfrom
docs-variables-separate-page

Conversation

@lukegalbraithrussell

@lukegalbraithrussell lukegalbraithrussell commented Apr 3, 2025

Copy link
Copy Markdown
Contributor

Summary

The homepage should be a home page not a home and topic page. now this topic is on a page.

We're immediately testing the worst edge case -- the resulting PR in the docusaurus repo will need to be modified to add the page to sidebar.js. Not too cumbersome to do via web client though

Requirements (place an x in each [ ])

@codecov

codecov Bot commented Apr 3, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.85%. Comparing base (d947f9a) to head (6f4029a).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #425   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files           7        7           
  Lines         702      702           
=======================================
  Hits          701      701           
  Misses          1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@zimeg zimeg added the docs Improvements or additions to documentation label Apr 3, 2025
zimeg
zimeg approved these changes Apr 3, 2025
View reviewed changes

@zimeg zimeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! 👾

So much random but of course organized detail about JSON and YAML parsings I'm hoping find this page soon 📝 ✨

@zimeg

zimeg commented Apr 3, 2025

Copy link
Copy Markdown
Member

...the resulting PR in the docusaurus repo will need to be modified to add the page to sidebar.js.

@lukegalbraithrussell

Woah. I'm now realizing that this lets us merge docs PRs separate from the "released" docs 📚 ✨

IIRC we've had pain points around merging bug fixes in documentation separate from feature additions and our release cycles, but it now could we hold off on merging certain PRs until a stable release!? 🚀

@zimeg

zimeg commented Apr 3, 2025

Copy link
Copy Markdown
Member

☝️ With those "certain PRs" meaning the PRs created for the docs site!

@lukegalbraithrussell
lukegalbraithrussell merged commit d07fadf into main Apr 3, 2025
@lukegalbraithrussell
lukegalbraithrussell deleted the docs-variables-separate-page branch April 3, 2025 23:00

This branch was previously deployed

1 inactive deployment
staging — 6f4029ae Deployed Apr 3, 2025 by lukegalbraithrussell
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zimeg zimeg zimeg approved these changes

Assignees

No one assigned

Labels

docs Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@lukegalbraithrussell @zimeg