Skip to content

feat(docs): Move E2E test docs under developer-guide#2150

Merged
jgwest merged 1 commit intoargoproj-labs:masterfrom
olivergondza:docs-move-e2e
Apr 8, 2026
Merged

feat(docs): Move E2E test docs under developer-guide#2150
jgwest merged 1 commit intoargoproj-labs:masterfrom
olivergondza:docs-move-e2e

Conversation

@olivergondza
Copy link
Copy Markdown
Collaborator

@olivergondza olivergondza commented Apr 8, 2026

This clutters the top level navigation.

What type of PR is this?

/kind cleanup

What does this PR do / why we need it:

Have you updated the necessary documentation?

  • Documentation update is required by this PR.
  • Documentation has been updated.

Which issue(s) this PR fixes:

No

How to test changes / Special notes to the reviewer:

Tested manually that it works, the only reference updated.

Summary by CodeRabbit

  • Documentation
    • Reorganized E2E testing documentation structure within the site navigation for improved accessibility and clarity.
    • Relocated E2E Testing guide from top-level navigation to the Contributing → Development section, consolidating all development-related resources in one logical location.
    • Updated documentation link paths and formatting across the development guide to ensure consistency.

This clutters the top level navigation.

Signed-off-by: Oliver Gondža <ogondza@gmail.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d0ec1235-0412-4deb-8251-bba92527a992

📥 Commits

Reviewing files that changed from the base of the PR and between 3e8a132 and 896f990.

📒 Files selected for processing (3)
  • docs/developer-guide/development.md
  • docs/developer-guide/e2e-test-guide.md
  • mkdocs.yml

📝 Walkthrough

Walkthrough

The E2E testing documentation was reorganized in the navigation hierarchy, moving it from a top-level entry to the Contributing/Development section. The corresponding documentation link was updated to use a relative path format consistent with the new structure.

Changes

Cohort / File(s) Summary
Navigation Restructuring
mkdocs.yml
Relocated "E2E Testing" navigation entry from top-level to under Contributing → Development section, updating the file path from e2e-test-guide.md to developer-guide/e2e-test-guide.md.
Link Path Update
docs/developer-guide/development.md
Updated the E2E testing documentation reference to use relative path syntax (./e2e-test-guide.md) with standard Markdown link formatting.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 With twitching nose, I organize with care,
Documentation nested, restructured fair!
Links now aligned in hierarchies deep,
The E2E tests in order, safe to keep! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: moving E2E test documentation under the developer-guide section, which is reflected in both mkdocs.yml navigation restructuring and docs updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Copy link
Copy Markdown
Member

@jgwest jgwest left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @olivergondza!

@jgwest jgwest merged commit da61f02 into argoproj-labs:master Apr 8, 2026
10 checks passed
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.

2 participants