Skip to content

docs: update documentation#91

Merged
vancura merged 1 commit intomainfrom
doc-update
Jan 19, 2026
Merged

docs: update documentation#91
vancura merged 1 commit intomainfrom
doc-update

Conversation

@vancura
Copy link
Copy Markdown
Collaborator

@vancura vancura commented Jan 19, 2026

Overview

This PR updates project documentation, descriptions, and code comments across configuration files, content files, and source code. The changes primarily involve refining project metadata, clarifying descriptions, and improving comment formatting throughout the codebase.

Key Changes

Project Description Updates

  • Updated package.json description to "A bilingual (English/Czech) marketing website and blog for Ambilab."
  • Updated SITE.DESCRIPTION in src/config/site.ts with consistent bilingual marketing-focused wording
  • Updated ai-rules/ambilab-website.mdc project description from a detailed technical description to a concise marketing description
  • Modified footer translations in src/i18n/translations.ts with updated English and Czech descriptions
  • Updated content metadata in various pages (index.mdx, about.mdx, hello-world.mdx) to reflect the marketing site positioning

Configuration File Cleanup

  • Removed unnecessary comment blocks from .husky/* files (commit-msg, pre-commit, ensure-pnpm.sh) to streamline pre-commit hook documentation
  • Removed detailed comments from .prettierignore explaining ignored blocks
  • Trimmed comments from configuration files including commitlint.config.js, eslint.config.js, lighthouserc.cjs, and prettier.config.js
  • Added periods to comment sentences in .vscode/settings.json, .markdownlint-cli2.jsonc, and wrangler.jsonc for consistency

Minor Code Improvements

  • Fixed grammatical issues in comments (e.g., "unsafe-hashes allows" vs "unsafe-hashes allow")
  • Updated comment phrasing for clarity in DemoEmbed.svelte ("Validate the aspect ratio" vs "Validate aspect ratio")
  • Updated comment in src/env.d.ts from "prerendered routes" to "pre-rendered routes"
  • Added inline comments explaining silent failures in scripts/run-lighthouse.mjs and src/utils/dom.ts

Configuration Adjustments

  • Expanded biome formatter configuration in .vscode/settings.json to include JavaScript, JSON, JSONC, and CSS scopes
  • Added new color tokens (menu-dimmer-bg, menu-dimmer-bg-dark) to tailwind.config.ts
  • Removed several comment headers in configuration files to reduce verbosity while maintaining functionality

Content Updates

  • Updated Czech page content (src/content/pages/cs/index.mdx) with proper hyphenation in "pixel-artu" and "Pixel-art editor"
  • Updated about page description to remove age-specific language, broadening the target audience

Impact

The changes are primarily non-functional, focusing on documentation clarity, consistency in commenting conventions, and alignment of project descriptions across the codebase to emphasize the bilingual marketing website positioning. Configuration behavior remains unchanged despite comment removals.

Signed-off-by: Vaclav Vancura <commit@vancura.dev>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 19, 2026

Walkthrough

This PR updates project documentation, configuration comments, and description text across the repository. It simplifies descriptions from technical (game engine) to marketing-focused (bilingual website/blog), removes comment blocks from various config files, adds error handling comments in scripts, expands Biome formatter scope, and updates Czech language hyphenation.

Changes

Cohort / File(s) Summary
Configuration comment and formatting cleanup
.gitignore, .markdownlint-cli2.jsonc, .prettierignore, prettier.config.js, wrangler.jsonc, commitlint.config.js, eslint.config.js
Removed comment blocks, added trailing periods to comments, cleaned up section headers, and adjusted formatting without changing functional behavior
Husky hook documentation updates
.husky/commit-msg, .husky/pre-commit, .husky/pre-push, .husky/ensure-pnpm.sh
Removed descriptive comment lines; pre-push hook now omits format, lint, and spellcheck checks
Project description and metadata updates
package.json, ai-rules/ambilab-website.mdc, src/config/site.ts, src/content/blog/en/hello-world.mdx, src/content/pages/en/index.mdx, src/content/pages/en/about.mdx, src/i18n/translations.ts
Updated descriptions from technical (web-based pixel art game engine for kids) to marketing-focused (bilingual English/Czech marketing website and blog for Ambilab)
VS Code and formatter configuration
.vscode/settings.json, astro.config.ts
Expanded Biome as default formatter for javascript, json, jsonc, and css scopes; added trailing periods to comments
Content text and hyphenation corrections
src/content/pages/cs/index.mdx, src/components/svelte/DemoEmbed.svelte, src/config/security.ts, src/env.d.ts
Updated Czech hyphenation for pixel-art references, refined comment phrasing, and corrected grammar in inline documentation
Error handling and script improvements
scripts/run-lighthouse.mjs, scripts/sync-rules.mjs, src/utils/dom.ts
Added explanatory comments in catch blocks for silent failures; updated help text grammar
Design system configuration
tailwind.config.ts, lighthouserc.cjs
Added menu-dimmer-bg color tokens; removed comment section headers while preserving color mappings and extensive comment/wording updates to lighthouse configuration

Possibly related PRs

🚥 Pre-merge checks | ✅ 1 | ❌ 2
❌ Failed checks (1 warning, 1 inconclusive)
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.
Title check ❓ Inconclusive The title 'docs: update documentation' is overly vague and generic. It uses non-descriptive language that doesn't convey meaningful information about the actual changes in the changeset. Replace with a more specific title that reflects the actual scope of changes, such as 'refactor: standardize configuration and content descriptions' or similar, to better summarize the primary changes.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch doc-update

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
Contributor

@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

🤖 Fix all issues with AI agents
In `@src/i18n/translations.ts`:
- Line 180: The Czech footer 'description' string is grammatically awkward and
diverges from the English bilingual marketing text; update the 'description'
value in the Czech translations (the 'description' entry in
src/i18n/translations.ts for the Czech locale) to a fluent, grammatically
correct Czech sentence that mirrors the English marketing message (i.e., a
concise bilingual-style tagline about a web pixel-art game engine). Ensure
punctuation and tone match other locales.

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