Contributing to the docs

The Loquix documentation is public and maintained alongside the component library. Corrections, clearer examples, accessibility improvements, and new component references are welcome.

Make a small edit

Every documentation page includes an Edit page link in its footer. Use it to open the source file on GitHub, make a focused change, and propose a pull request.

Good first contributions include:

correcting an API table against custom-elements.json;
adding a missing event detail or slot;
improving an example without adding application-specific dependencies;
documenting keyboard or screen-reader behavior;
fixing a broken link, typo, or unclear explanation.

Work locally

Clone the documentation repository.

git clone https://github.com/loquix-dev/docs.git
cd docs

Install dependencies and start the site.
Terminal window
```
pnpm install
pnpm dev
```
Edit or add a page in src/content/docs.
Run the release checks.
Terminal window
```
pnpm validate
```
Open a focused pull request. Include a screenshot when the rendered output changes.

Component page standard

A complete component reference should contain:

a short purpose statement;
a live preview using the published @loquix/core package;
definition import and practical usage;
properties and their corresponding attributes;
events with detail shapes;
slots, public methods, CSS parts, and custom properties when available;
accessibility, state, or security notes where the integration needs them.

Use the generated manifest in @loquix/core/custom-elements.json as the API source of truth. Use the component source and Storybook stories to verify behavior and realistic examples.

Report an issue

Please include the component name, browser, Loquix version, expected behavior, and a minimal reproduction when reporting a component issue.