stacklok/docs-website

Dernière activité source enregistrée: 10 septembre 2026 à 17:05

Catalogue SkillsMP mis à jour: 29 octobre 2026 à 18:30

skills collectés: 10

Étoiles GitHub: 4
Forks GitHub: 4

Installer avec un assistant IA

Copiez ce prompt dans l’assistant IA que vous utilisez.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/stacklok/docs-website.

README du dépôt

Fichier source du README : README.md

Lire le README source

Afficher le README complet

# Stacklok docs  [![GitHub deployments][deployment-img]][deployment] This repository contains the public-facing docs for Stacklok's projects, hosted at [https://docs.stacklok.com](https://docs.stacklok.com). - [Contributing to docs](#contributing-to-docs) - [Reporting issues](#reporting-issues) - [Local development](#local-development) - [Formatting](#formatting) - [Building the site](#building-the-site) - [Deployment](#deployment) - [License](#license) - [About](#about) ## Contributing to docs We welcome contributions to the Stacklok documentation - if you find something missing, wrong, or unclear, please let us know via an issue or open a PR! Please review the [style guide](./STYLE-GUIDE.md) for help with voice, tone, and formatting. ### Reporting issues Found a problem with the documentation? We have issue templates to help you report it: - **[Documentation error](https://github.com/stacklok/docs-website/issues/new?template=01-doc-error.yml)** - Report incorrect, outdated, or unclear content - **[Documentation gap](https://github.com/stacklok/docs-website/issues/new?template=02-doc-gap.yml)** - Request documentation for features that aren't covered - **[Documentation enhancement](https://github.com/stacklok/docs-website/issues/new?template=03-doc-enhancement.yml)** - Suggest improvements to existing content For general questions, please visit [Stacklok's community Discord](https://discord.gg/stacklok). ## Local development You'll need Node.js available (v24 recommended) or VS Code with the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension and Docker. [![Open in Dev Containers][devcontainer-img]][devcontainer] ```bash npm install npm run start ``` This command starts a local development server on port 3000 and opens a browser window to <http://localhost:3000>. Most changes are reflected live without having to restart the server. ## Formatting We use Prettier and ESLint to normalize formatting and syntax. Before you submit a PR, please check for issues: ```bash npm run prettier npm run eslint ``` To automatically fix issues: ```bash npm run prettier:fix npm run eslint:fix ``` The formatting commands also run as a pre-commit hook using [Husky](https://typicode.github.io/husky/), so commits will fail if there are formatting issues that can't be fixed automatically. You can skip this by using `git commit --no-verify`, but it's recommended to fix the issues instead since the P workflow will fail the checks anyway. ## Building the site ```bash npm run build ``` This command generates static content into the `build` directory. It also checks for broken links, so it's recommended to run this before submitting a PR. ## Deployment The `docs.stacklok.com` site is published using Vercel. Automatic previews for branches and pull requests are enabled. The production site is published from the `main` branch. ## License This repository is primarily documentation, so the default license is for content. Code is licensed separately: - **Documentation content** (Markdown and MDX files under `/docs` and `/blog`, plus accompanying images and diagrams) is licensed under [Creative Commons Attribution 4.0 International (CC BY 4.0)](./LICENSE). - **Code** (anything that compiles, runs, or configures the site - including `.ts`, `.tsx`, `.js`, `.mjs`, `.css`, and config files) is licensed under the [Apache License 2.0](./LICENSE-code). Most source files carry SPDX headers identifying this; a small number of top-level config files do not, and inherit the code license by virtue of being code. This split follows the convention used by the [Kubernetes website repository](https://github.com/kubernetes/website). Stacklok trademarks, logos, and brand marks (including the contents of `/static/img/logos/` and the Stacklok wordmark and icon used throughout the site) are excluded from both licenses and remain the property of Stacklok, Inc. A small number of source files carry their own upstream license headers (for example, components adapted from the Docusaurus community knowledge base under CC BY-SA 4.0, theme components ejected from Docusaurus under MIT, and Font Awesome assets). In those files the file-level header is authoritative for that file. ## About This site is built with [Docusaurus](https://docusaurus.io/).  [deployment-img]: https://img.shields.io/github/deployments/stacklok/docs-website/Production?logo=vercel&label=Vercel%20deployment [deployment]: https://github.com/stacklok/docs-website/deployments/Production [devcontainer-img]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue [devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/stacklok/docs-website

Chargement du README du dépôt…

Skills dans ce dépôt

Développeurs de logiciels Analystes en assurance qualité des logiciels et testeurs Rédacteurs techniques Graphistes

4 catégories métier · 100% classifié

skill

métier

description

mis à jour

docs-review

Développeurs de logiciels

Perform comprehensive editorial reviews of documentation with a tech writer / copyeditor lens. Use when asked to review docs, documentation changes, or a set of changed files - especially net-new documentation or LLM-generated content. Reviews can be for…