Skip to content

Make Fundamentals the starting page. Merge LICENSE from main#427

Merged
k3dz0r merged 37 commits into
developfrom
2026-05-14
May 14, 2026
Merged

Make Fundamentals the starting page. Merge LICENSE from main#427
k3dz0r merged 37 commits into
developfrom
2026-05-14

Conversation

@k3dz0r
Copy link
Copy Markdown
Collaborator

@k3dz0r k3dz0r commented May 14, 2026

Summary by CodeRabbit

  • Documentation

    • Reorganized documentation structure with separate Fundamentals and CLI sections.
    • Updated navigation menu to display Fundamentals first.
    • Changed default landing page to direct users to Fundamentals.
  • Chores

    • Added Business Source License 1.1 file.

Review Change Stack

k3dz0r and others added 30 commits August 19, 2025 12:59
cli: add provider-tools guide
add cli guides, hide whitepaper
Update fundamentals/certification-system; add Python example guide
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

Walkthrough

The PR adds a Business Source License 1.1 to the repository and restructures the documentation site to serve fundamentals and CLI documentation as independent Docusaurus sections, each with separate routing and plugins, updating the homepage default redirect accordingly and adjusting sidebar ordering.

Changes

Documentation Site Restructuring and License

Layer / File(s) Summary
License addition
LICENSE
Business Source License 1.1 text is added to govern the repository.
Docusaurus multi-section plugin configuration
docusaurus.config.js
Two separate docs plugins are configured for "fundamentals" (path: "./docs/fundamentals", routeBasePath: "/fundamentals") and "cli" (path: "./docs/cli", routeBasePath: "/cli"). Navbar items are updated to reference the plugin ids, and local search routing includes both doc sections.
Homepage redirect and fundamentals sidebar ordering
src/pages/index.js, docs/fundamentals/index.md
Homepage redirect target changes from /cli to /fundamentals. Fundamentals page sidebar position is adjusted from 1 to 0 to establish priority in the reorganized structure.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A license to hop, two docs in the bin,
Fundamentals first, with sidebar skin,
CLI follows close on its destined path,
Homepage now guides to fundamentals' bath! 🌿

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 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 two main changes: making Fundamentals the starting page and merging the LICENSE file from main.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-05-14

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (2)
docusaurus.config.js (2)

33-36: 💤 Low value

Consider removing the commented code.

Since the homepage redirect is now handled in src/pages/index.js, the commented configuration is no longer needed and can be removed to keep the codebase clean.

♻️ Suggested cleanup
        redirects: [
-          /*{ // See src/pages/index.js
-            from: "/",
-            to: "/cli",
-          },*/
          {
            from: "/archive/data-for-ai",
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docusaurus.config.js` around lines 33 - 36, Remove the now-obsolete commented
route object in docusaurus.config.js (the block containing from: "/" and to:
"/cli") since homepage redirect is implemented in src/pages/index.js; delete
that commented code block to clean up the config and leave no residual commented
routing entries.

145-145: 💤 Low value

Consider aligning the order with the navbar for consistency.

The docsRouteBasePath array lists "cli" before "fundamentals", while the navbar items list "Fundamentals" first. Although the order doesn't affect functionality (search will index both paths), aligning the order with the navbar configuration would improve consistency.

♻️ Suggested alignment
-      docsRouteBasePath: ["cli", "fundamentals"],
+      docsRouteBasePath: ["fundamentals", "cli"],
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docusaurus.config.js` at line 145, The docsRouteBasePath array order is
inconsistent with the navbar; update the docsRouteBasePath setting (the
docsRouteBasePath array) to list "fundamentals" before "cli" so it aligns with
the navbar order (i.e., change ["cli","fundamentals"] to ["fundamentals","cli"])
to maintain consistent ordering across config.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docusaurus.config.js`:
- Around line 33-36: Remove the now-obsolete commented route object in
docusaurus.config.js (the block containing from: "/" and to: "/cli") since
homepage redirect is implemented in src/pages/index.js; delete that commented
code block to clean up the config and leave no residual commented routing
entries.
- Line 145: The docsRouteBasePath array order is inconsistent with the navbar;
update the docsRouteBasePath setting (the docsRouteBasePath array) to list
"fundamentals" before "cli" so it aligns with the navbar order (i.e., change
["cli","fundamentals"] to ["fundamentals","cli"]) to maintain consistent
ordering across config.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7f7f4eb1-15da-40e7-b928-f0acb7debd22

📥 Commits

Reviewing files that changed from the base of the PR and between 68f1dad and 6888f13.

📒 Files selected for processing (4)
  • LICENSE
  • docs/fundamentals/index.md
  • docusaurus.config.js
  • src/pages/index.js

@k3dz0r k3dz0r merged commit 5c0c84a into develop May 14, 2026
6 checks passed
@k3dz0r k3dz0r deleted the 2026-05-14 branch May 14, 2026 14:41
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