fix(docs): align Cedarling docs file naming and structure with navigation by ossdhaval · Pull Request #12710

📝 Walkthrough

Walkthrough

Reorganizes Cedarling documentation structure and navigation: moves files into new quick-start/, tutorials/, developer/, reference/, and integrations/ directories; updates internal links, anchors, and image paths; and adjusts mkdocs.yml navigation entries. No code or public API changes.

Changes

Cohort / File(s)	Summary
Documentation Root docs/cedarling/README.md	Updated internal reference links to point to ./reference/ subdirectory for properties, policy store, and logs.
Developer Guides docs/cedarling/developer/cedarling-kotlin.md, docs/cedarling/developer/cedarling-rust.md	Adjusted cross-reference links to new developer/tutorial/reference paths; clarified build-from-source phrasing and updated See Also targets.
Sidecar Docs & Assets docs/cedarling/developer/sidecar/cedarling-sidecar-overview.md, docs/cedarling/developer/sidecar/cedarling-sidecar-tutorial.md	Updated authentication link path and changed image asset references from ../assets to ../../../assets.
Tutorials docs/cedarling/tutorials/cedarling-getting-started.md, docs/cedarling/tutorials/java.md, docs/cedarling/tutorials/javascript.md, docs/cedarling/tutorials/python.md, docs/cedarling/tutorials/rust.md	Rewrote in-page and cross-page links to point to new quick-start/, developer/, and reference/ locations and updated See Also targets and anchors.
Quick-Start docs/cedarling/quick-start/cedarling-quick-start.md	Updated anchor/link targets from ./README.md to ../README.md and adjusted TBAC link text/anchor.
Reference Docs docs/cedarling/reference/cedarling-terms.md, docs/cedarling/reference/cedarling-logs.md, docs/cedarling/reference/cedarling-lock-server.md	Updated cross-reference targets to ../reference/ paths and corrected an SSA screenshot/image path.
Site Navigation mkdocs.yml	Reorganized Cedarling navigation: moved items into reference/, developer/, quick-start/, tutorials/, and integrations/; removed Client Authentication endpoint entry; updated cross-references to new paths.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Mixed, repo-wide doc/link updates with one central mkdocs.yml restructure increase review scope.
Spot-checks recommended:
- Relative path correctness for deep ../../../assets references (sidecar tutorial).
- Anchor/section IDs referenced in updated links.
- mkdocs.yml navigation reflects actual file locations and no broken entries.
- Image links (SSA screenshot) resolve correctly.

Listen up, my friend — you better think twice when checking those relative paths!

fix(docs): broken link in the Cedarling Rust Developer Guide #12495 — Modifies cedarling-rust and TBAC/See Also links; aligns with the cross-reference fixes in this PR.

Fix link to Cedarling TBAC quickstart in Python docs #12558 — Updates Cedarling Python docs TBAC quickstart anchor, matching similar anchor changes here.
fix(docs): fix link of cedarling in a javascript app #12593 — Adjusts Cedarling JavaScript TBAC quickstart anchor updated in this PR.
docs(jans-cedarling): update quickstart #12443 — Touches cedarling-quick-start content and likely overlaps with moved/updated quick-start links.

Suggested labels

comp-jans-cedarling

Suggested reviewers

manojs1978

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is incomplete. The target issue field contains only a placeholder 'closes #issue-number-here', and critical checklist items are unchecked.	Update the PR description to reference the actual issue #12711, check the documentation update checkbox, and provide implementation details for the structural changes made.
Linked Issues check	❓ Inconclusive	The linked issue #12711 is auto-generated with minimal description and lacks specific coding requirements or objectives to validate against the changes.	Ensure the linked issue #12711 is updated with clear scope, objectives, and requirements for the documentation restructuring work to enable proper validation.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: aligning Cedarling documentation file naming and structure with the navigation system.
Out of Scope Changes check	✅ Passed	All changes are in-scope documentation updates: file relocations, link corrections, and navigation configuration updates to align with the new Cedarling directory structure.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches 🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs-update-cedarling-menu

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f67fbf3 and da40e76.

📒 Files selected for processing (1)

mkdocs.yml (1 hunks) 🔇 Additional comments (3)

mkdocs.yml (3)

429-429: Heads-up: New go.md tutorial detected. 🕊️

The Cedarling tutorials section now includes a Go language entry (cedarling/tutorials/go.md). If this is a new addition to the PR, make sure:

The file exists

It follows the same structure/format as other language tutorials

Documentation build doesn't warn about it

447-448: Nice structure for Python developer docs! 🕊️

You've broken up the Python developer guide into a subdirectory (cedarling/developer/python/) with a README.md and usage.md. This mirrors how other complex sections are organized—good call! Just make sure:

Both README.md and usage.md have the right content

Navigation links within these files point to the correct paths (especially cross-references to other Cedarling sections)

420-458: All systems go, pigeon! The documentation files are rockin'! 🕊️

Hold up—I ran the verification script and got some excellent news! Every single one of those 30 markdown files referenced in your Cedarling section? They're all sitting pretty at their new paths. No stragglers, no missing pieces. The docs directory is singing in harmony with mkdocs.yml.

Here's what the script confirmed:

✓ All 30 files exist (cedarling/quick-start/, cedarling/tutorials/, cedarling/reference/, cedarling/developer/, and cedarling/integrations/)

✓ YAML paths match actual file locations

✓ No broken references in the navigation structure itself

Your reorganization is solid. The Cedarling documentation is now neatly tucked into its organized subdirectories, and mkdocs.yml is pointing to the right places. Time to celebrate—this one's good to fly!

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

Provide your own instructions using the high_level_summary_instructions setting.
Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

📝 Description — Summarize the main change in 50–60 words, explaining what was done.

📓 References — List relevant issues, discussions, documentation, or related PRs.

📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.

📊 Contributor Summary — Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |

✔️ Additional Notes — Add any extra reviewer context.
Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

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.

fix(docs): align Cedarling docs file naming and structure with navigation by ossdhaval · Pull Request #12710 · JanssenProject/jans (original) (raw)