Skip to content

chore(docs): normalize docs scaffold#59

Merged
jonathanperis merged 1 commit into
mainfrom
docs/normalize-scaffold
May 8, 2026
Merged

chore(docs): normalize docs scaffold#59
jonathanperis merged 1 commit into
mainfrom
docs/normalize-scaffold

Conversation

@jonathanperis
Copy link
Copy Markdown
Owner

@jonathanperis jonathanperis commented May 8, 2026

Summary

  • Normalize docs scaffold files across repositories.
  • Remove noncanonical docs-only files and keep project content under docs/wiki and docs/public.
  • Preserve benchmark-only reports behavior where applicable.

Verification

  • bun run build

Summary by CodeRabbit

  • Documentation

    • Simplified README with updated Bun package manager command examples (bun install, bun run dev/build/preview) and clarified environment variable setup.
  • Chores

    • Removed VS Code extension recommendations configuration.
    • Removed VS Code debug launch configuration.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR removes VS Code developer configuration files and rewrites the README documentation in the docs/ directory with a simplified format, replacing npm commands with Bun equivalents and condensing project metadata.

Changes

Documentation and Dev Configuration Simplification

Layer / File(s) Summary
VS Code Configuration Removal
docs/.vscode/extensions.json, docs/.vscode/launch.json
Removes the astro-build.astro-vscode extension recommendation and the Astro dev server launch configuration.
README Content Refresh
docs/README.md
Replaces detailed project description and npm commands with a minimal header, Bun-based command equivalents (bun install, bun run dev/build/preview), and simplified environment variable documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore(docs): normalize docs scaffold' accurately reflects the main changes: removing VS Code configuration files (.vscode/extensions.json and .vscode/launch.json) and simplifying the docs README as part of normalizing the docs scaffold structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/normalize-scaffold

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.

Actionable comments posted: 1

🤖 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.

Inline comments:
In `@docs/README.md`:
- Around line 11-14: Add explicit Bun config to the docs package: in the docs
package.json add a "packageManager" field set to the project's Bun version (e.g.
"bun@x.y.z") and generate/commit the bun.lockb lockfile by running Bun install
in that package (so the existing scripts "dev", "build", "preview" continue to
work but now have an explicit package manager and lockfile).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 620b8978-ef18-4d99-8edc-99a7452f40ee

📥 Commits

Reviewing files that changed from the base of the PR and between e3052d7 and 2c29d00.

⛔ Files ignored due to path filters (1)
  • docs/package-lock.json is excluded by !**/package-lock.json, !**/package-lock.json
📒 Files selected for processing (3)
  • docs/.vscode/extensions.json
  • docs/.vscode/launch.json
  • docs/README.md
💤 Files with no reviewable changes (2)
  • docs/.vscode/extensions.json
  • docs/.vscode/launch.json

Comment thread docs/README.md
Comment on lines +11 to +14
| `bun install` | Install dependencies |
| `bun run dev` | Start dev server |
| `bun run build` | Build to `./out/` |
| `bun run preview` | Preview production build locally |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify Bun configuration and available scripts in docs/package.json

# Check if package.json exists in docs/ directory
if [ -f docs/package.json ]; then
  echo "=== docs/package.json found ==="
  cat docs/package.json | jq '.scripts'
  
  # Check for packageManager field
  echo -e "\n=== Package manager field ==="
  cat docs/package.json | jq '.packageManager // "not specified"'
else
  echo "ERROR: docs/package.json not found"
  exit 1
fi

# Check for bun lockfile
echo -e "\n=== Bun lockfile check ==="
if [ -f docs/bun.lockb ]; then
  echo "✓ bun.lockb found"
else
  echo "⚠ bun.lockb not found (expected for Bun projects)"
fi

Repository: jonathanperis/rinha2-back-end-rust

Length of output: 336


Address missing Bun configuration in docs directory.

The scripts (dev, build, preview) exist in docs/package.json and Bun can execute them, but Bun is not explicitly configured as the package manager:

  • No packageManager field is set in package.json (best practice: "packageManager": "bun@x.x.x")
  • No bun.lockb lockfile exists

While bun run <script> will work, consider adding explicit Bun configuration to match the tool's intent and ensure consistency across the project.

🤖 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 `@docs/README.md` around lines 11 - 14, Add explicit Bun config to the docs
package: in the docs package.json add a "packageManager" field set to the
project's Bun version (e.g. "bun@x.y.z") and generate/commit the bun.lockb
lockfile by running Bun install in that package (so the existing scripts "dev",
"build", "preview" continue to work but now have an explicit package manager and
lockfile).

@jonathanperis jonathanperis merged commit 1fdf63e into main May 8, 2026
5 checks passed
@jonathanperis jonathanperis deleted the docs/normalize-scaffold branch May 8, 2026 20:17
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