Skip to content

docs: bring the README in line with the Sevalla brand guidelines - #14

Merged
kotapeter merged 1 commit into
mainfrom
docs/readme-brand-guidelines
Oct 28, 2026
Merged

kotapeter merged 1 commit into
mainfrom
docs/readme-brand-guidelines

Conversation

@kotapeter

Copy link
Copy Markdown
Contributor

Brings the README in line with the GitHub guidelines in sevalla-design (guidelines/github.md and snippets/github/repository-README.md).

Changed

  • Header from the template: the 64 px mark from assets.sevalla.com, "Sevalla CLI", the one-line description, then a Docs · Sevalla links row. Removed the rule under the header.
  • Badges in the guideline order (CI, npm, license, Node.js), in stone 600 (#57534e).
  • The intro no longer says "official" and uses the About line's wording.
  • Sections follow the template order: Install, Quick start, Usage, Authentication, Development, License. Global options and shell completion now sit under Usage; the environment variables table sits under Authentication.
  • Headings in sentence case: "Quick start", "Device authorization (interactive)", "API token (CI/CD and scripting)", "Static sites", "Object storage" and so on.
  • Code blocks are fenced as sh, and comments go on the line above the command.
  • Examples use the docs' sample names (storefront, shop.example.com). Secrets come from the environment ("$DB_PASSWORD", "$REGISTRY_TOKEN") or a placeholder (<api-token>) instead of a pasted value.
  • Quick start now ends with a deploy.
  • The dashboard link points to app.sevalla.com, and the development step uses cd cli instead of cd sevalla-cli.

Fixed

  • Added --confirm to apps processes delete, pipelines stages apps remove and projects services remove. All three exit without it.
  • Documented object-storage rotate-credentials.

The repository links stay on the sevalla org (#12). sevalla-design still says sevalla-hosting.

@kotapeter
kotapeter merged commit 6050f8e into main Oct 28, 2026
3 checks passed
@kotapeter
kotapeter deleted the docs/readme-brand-guidelines branch October 28, 2026 10:14
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 2.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants