Skip to content

docs: move specs from doc/specs to docs/specs - #245

Merged
chaoming0625 merged 1 commit into
mainfrom
worktree-docs-rename-specs
Oct 20, 2026
Merged

chaoming0625 merged 1 commit into
mainfrom
worktree-docs-rename-specs

Conversation

@chaoming0625

@chaoming0625 chaoming0625 commented Oct 20, 2026 •

Copy link
Copy Markdown
Collaborator

Moves the design specs from the top-level doc/specs/ into the existing docs/specs/ folder, removes the now-empty doc/, and updates the spec path in AGENTS.md (rule 8) and in the audit spec.

Summary by Sourcery

Move design specifications to docs/specs/ and update all documented references to the new location.

Enhancements:

  • Consolidate design specifications under the existing docs/specs/ directory and remove the obsolete top-level doc/ directory.

Documentation:

  • Update contributor guidance and the audit specification to reference docs/specs/.

@sourcery-ai

sourcery-ai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The PR consolidates design specs under docs/specs/, removes the obsolete doc/ hierarchy, and updates the repository guidance and audit workflow references to match the new location while preserving spec contents.

File-Level Changes

Change Details Files
Relocate all design specifications from the legacy top-level directory into the established documentation directory and remove the obsolete directory.
  • Rename the four specification files under doc/specs/ into docs/specs/, preserving their contents.
  • Delete the now-empty doc/ directory.
doc/specs/2026-10-audit-fixes.md
docs/specs/2026-10-audit-fixes.md
doc/specs/ci-optional-framework-jax-compat.md
docs/specs/ci-optional-framework-jax-compat.md
doc/specs/jax-0.12-compat.md
docs/specs/jax-0.12-compat.md
doc/specs/respect-jax-x64-on-import.md
docs/specs/respect-jax-x64-on-import.md
Update documentation and workflow references to use the new specification path.
  • Change AGENTS.md rule 8 from doc/specs to docs/specs.
  • Update the audit specification's workflow instruction to reference its new location.
AGENTS.md
docs/specs/2026-10-audit-fixes.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@chaoming0625
chaoming0625 merged commit 649af53 into main Oct 20, 2026
7 checks passed
@chaoming0625
chaoming0625 deleted the worktree-docs-rename-specs branch October 20, 2026 07:26

@sourcery-ai sourcery-ai Bot 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.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@codecov

codecov Bot commented Oct 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

1 participant