Skip to content

docs(integration-tests): Restructure dev-docs directory to accommodate package integration test docs.#1686

Open
quinntaylormitchell wants to merge 7 commits intoy-scope:mainfrom
quinntaylormitchell:docs-package-integration-testing
Open

docs(integration-tests): Restructure dev-docs directory to accommodate package integration test docs.#1686
quinntaylormitchell wants to merge 7 commits intoy-scope:mainfrom
quinntaylormitchell:docs-package-integration-testing

Conversation

@quinntaylormitchell
Copy link
Collaborator

@quinntaylormitchell quinntaylormitchell commented Nov 28, 2025

Description

This PR restructures the dev-docs directory in preparation for docs on package integration tests and binary integration tests.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Built and served docs.

Summary by CodeRabbit

  • Documentation
    • Restructured integration tests documentation with dedicated sections for testing CLP package and binaries.
    • Updated testing documentation navigation structure and cross-references for improved content organization.
    • Added new reference pages for CLP package and binary testing procedures (currently under construction).

✏️ Tip: You can customize this high-level summary in your review settings.


@quinntaylormitchell quinntaylormitchell requested a review from a team as a code owner November 28, 2025 16:51
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 28, 2025

Walkthrough

Documentation restructuring that updates navigation links to point to an index file within the integration-tests directory, adds two new documentation pages for testing CLP packages and binaries, and reorganizes the main integration tests documentation page with expanded sections.

Changes

Cohort / File(s) Summary
Navigation link updates
docs/src/dev-docs/index.md, docs/src/dev-docs/testing/index.md
Updated toctree and grid-item-card links from testing/integration-tests to testing/integration-tests/index, redirecting navigation to the index file within the integration-tests subdirectory
Integration tests index restructuring
docs/src/dev-docs/testing/integration-tests/index.md
Expanded to include sections for testing CLP package and binaries; replaced pytest-marker guidance with toctree directive linking to package and binary subpages
New documentation pages
docs/src/dev-docs/testing/integration-tests/package.md, docs/src/dev-docs/testing/integration-tests/binary.md
Added two new documentation files with headings and under-construction warning admonitions for testing CLP package and binaries respectively

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Multiple files involved, but all documentation-related with straightforward, consistent updates
  • Navigation changes follow a clear repetitive pattern (adding /index to paths)
  • New files contain minimal content (headings and warning blocks)
  • No code logic, logic density, or complex interdependencies to evaluate
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: restructuring the dev-docs directory to support package and binary integration test documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Bill-hbrhbr
Bill-hbrhbr previously approved these changes Dec 3, 2025
Copy link
Contributor

@Bill-hbrhbr Bill-hbrhbr left a comment

Choose a reason for hiding this comment

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

I don't see any issue and don't have a strong opinion of splitting the test guide into more granular chunks. Need to ask maintainers about this split.

@Bill-hbrhbr
Copy link
Contributor

Let's merge this only after the package task is in. #1664

junhaoliao
junhaoliao previously approved these changes Dec 4, 2025
@junhaoliao junhaoliao requested review from kirkrodrigues and removed request for kirkrodrigues December 11, 2025 21:08
Comment on lines 20 to 41
### Using `pytest` markers

To run more specific sets of tests, you can use `pytest` directly with `pytest` markers.

:::{note}
Before running tests using `pytest`, ensure that the CLP package and/or core binaries have been
built.
:::

Ensure all commands below are run from inside the `integration-tests` directory.

To list all available markers:

```shell
uv run pytest --markers
```

To run tests related to a specific marker (e.g., `clp_s`):

```shell
uv run pytest -m clp_s
```
Copy link
Member

Choose a reason for hiding this comment

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

Why'd we get rid of this?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

because the content will be modified and inserted into both integration-tests/binary.md and integration-tests/package.md in future PRs. each one of those files will have a "Running specific tests with pytest" section that'll talk about using pytest directly and how to use markers and stuff like that (with the information tailored to binary testing and package testing respectively).

that being said, for the time being I can just put it in integration-tests/index.md (I do have the content saved on a local branch but I agree there's no real need to get rid of the content in this PR)

@junhaoliao junhaoliao added this to the Backlog milestone Jan 19, 2026
@junhaoliao junhaoliao modified the milestones: Backlog, February 2026 Feb 1, 2026
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.

4 participants