Skip to content

chore(docs): normalize docs scaffold #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanperis merged 1 commit into from
May 8, 2026
Merged

chore(docs): normalize docs scaffold #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/.vscode/extensions.json
View file
Open in desktop

This file was deleted.

11 changes: 0 additions & 11 deletions docs/.vscode/launch.json
View file
Open in desktop

This file was deleted.

55 changes: 8 additions & 47 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,61 +1,22 @@
# rinha2-back-end-rust — GitHub Pages
# Docs

Astro 5 static site for the [rinha2-back-end-rust](https://github.com/jonathanperis/rinha2-back-end-rust) project. Deployed to GitHub Pages at [jonathanperis.github.io/rinha2-back-end-rust](https://jonathanperis.github.io/rinha2-back-end-rust/).

## Stack

| Technology | Purpose |
|---|---|
| Astro 5 | Static site generator |
| React 19 | Interactive islands (docs sidebar, search, scrollspy) |
| Tailwind CSS v4 | Utility-first styling for docs components |
| `@astrojs/sitemap` | Auto-generated sitemap |

## Structure

```
docs/
├── public/
│ ├── images/ # Grafana/Gatling metric screenshots
│ └── reports/ # k6 stress test HTML reports (appended by CI)
└── src/
├── components/
│ ├── home/ # Landing page components (Navbar, Hero, Dashboard, Footer)
│ └── docs/ # Docs page components (DocPageIsland, Sidebar, sections/)
├── hooks/
│ └── useScrollspy.ts
├── layouts/
│ └── BaseLayout.astro
├── pages/
│ ├── index.astro # Landing page
│ └── docs.astro # Documentation page
└── styles/
└── globals.css
```
Astro static site deployed to GitHub Pages.

## Commands

Run from this directory (`docs/`):

| Command | Action |
|---|---|
| `npm install` | Install dependencies |
| `npm run dev` | Start dev server at `localhost:4321` |
| `npm run build` | Build to `./out/` |
| `npm run preview` | Preview the production build locally |
| `bun install` | Install dependencies |
| `bun run dev` | Start dev server |
| `bun run build` | Build to `./out/` |
| `bun run preview` | Preview production build locally |
Comment on lines +11 to +14
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 8, 2026

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


## Environment

Copy `.env.example` to `.env` and fill in your values:

```sh
cp .env.example .env
```
Copy `.env.example` to `.env` and fill in local values when needed.

| Variable | Description |
|---|---|
| `PUBLIC_GA_ID` | Google Analytics 4 Measurement ID |

## Deployment

Deployed automatically on every push to `main` via `.github/workflows/deploy.yml`. The `PUBLIC_GA_ID` secret must be set in the repository's GitHub Actions secrets.
| `PUBLIC_GA_ID` | Optional Google Analytics 4 Measurement ID |
Loading
Loading