Skip to content

Enhance documentation by adding a Developer section in SUMMARY.md and…#8

Open
thomaskimura wants to merge 1 commit intomainfrom
thomas/bl-404-write-developer-docs-for-slab
Open

Enhance documentation by adding a Developer section in SUMMARY.md and…#8
thomaskimura wants to merge 1 commit intomainfrom
thomas/bl-404-write-developer-docs-for-slab

Conversation

@thomaskimura
Copy link
Member

@thomaskimura thomaskimura commented Mar 3, 2026

… linking it in README.md


Note

Low Risk
Low risk documentation-only change that adds new markdown pages and updates navigation links; no runtime code paths are modified.

Overview
Adds a new Developer documentation section under slab/developer/ with guides for project setup, GitHub Actions, AI workflows, agent skills/commands, CSS, JavaScript, and theme variable/data flow.

Updates slab/SUMMARY.md to include this new section in the table of contents and updates slab/README.md to link to the Developer docs from the helpful links table.

Written by Cursor Bugbot for commit f8d18bc. This will update automatically on new commits. Configure here.

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.


- `/Users/thomaskimura/Documents/GitHub/slab/.agents/skills/`
- `/Users/thomaskimura/Documents/GitHub/slab/.cursor/skills/`
- `/Users/thomaskimura/Documents/GitHub/slab/.cursor/commands/`
Copy link

Choose a reason for hiding this comment

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

Local machine paths committed to public documentation

Medium Severity

Every new documentation file under slab/developer/ contains "Canonical files" sections listing absolute paths rooted at /Users/thomaskimura/Documents/GitHub/slab/. These are one developer's local machine paths and are meaningless — and potentially confusing or embarrassing — to anyone else reading the published docs. The same pattern appears in all seven new files: agent-skills-and-commands.md, css.md, github-actions.md, javascript.md, project-setup.md, using-ai.md, and variables.md. These paths were likely generated by an AI tool that captured the author's local environment and should be repository-relative paths instead.

Additional Locations (2)

Fix in Cursor Fix in Web

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