docs: update docs subproject readme#554
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the documentation subproject README to reflect the current (manual) process for updating the embedded Sphinx Stack configuration, replacing outdated automation-based steps.
Changes:
- Replaces the removed/obsolete “run update script” workflow with a “diff relevant files and copy changes” workflow.
- Consolidates dependency refresh steps and adds a final verification reminder against the Sphinx Stack changelog.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@jahn-junior I had another look, and felt it needed more elaboration. |
jahn-junior
left a comment
There was a problem hiding this comment.
Question before I do another pass:
Are we writing these instructions primarily for the craft apps or Starbase itself? If it's the craft apps, is updating only the docs files something we see ourselves (or other contributors) doing?
I ask because I assumed we'd be most commonly incorporating tooling changes in our routine Starbase merges.
It's for the craft apps. So far the subproject has updated much more frequently than Starbase merges take place. This is a record of the goal that others can pick up. |
The instructions were incorrect and out of date.
make lint && make test.