Skip to content

docs: update docs subproject readme#554

Open
medubelko wants to merge 4 commits into
canonical:mainfrom
medubelko:docs-update-update-readme
Open

docs: update docs subproject readme#554
medubelko wants to merge 4 commits into
canonical:mainfrom
medubelko:docs-update-update-readme

Conversation

@medubelko

Copy link
Copy Markdown
Contributor

The instructions were incorrect and out of date.


  • I've followed the contribution guidelines.
  • I've signed the CLA.
  • I've successfully run make lint && make test.
  • I've added or updated any relevant documentation.
  • In documents I changed, I added a meta description if one was missing.
  • I've updated the relevant release notes.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread docs/README.md Outdated
Comment thread docs/README.md
@medubelko

Copy link
Copy Markdown
Contributor Author

@jahn-junior I had another look, and felt it needed more elaboration.

@medubelko medubelko requested a review from jahn-junior June 8, 2026 20:09

@jahn-junior jahn-junior left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

@medubelko

Copy link
Copy Markdown
Contributor Author

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?

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.

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.

3 participants