Skip to content

gen(add): guideflow for contributing #5904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nerda-codes merged 1 commit into from
Dec 2, 2025
Merged

gen(add): guideflow for contributing #5904

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion pages/guidelines.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,17 @@ import image6 from './assets/scaleway-creation-wizard.webp'
import image8 from './assets/scaleway-screenshot-annotation.webp'


This document sets out the writing guidelines (style guide) for Scaleway Documentation, including grammar, formatting, and standardized terminology. These guidelines should be followed by both internal and external contributors when making additions to the Scaleway Documentation site.
This document shows you how to edit content from the Scaleway documentation website, and sets out the writing guidelines (style guide) for Scaleway Documentation, including grammar, formatting, and standardized terminology. These guidelines should be followed by both internal and external contributors when making additions to the Scaleway Documentation site.

- For details on contributing to the Scaleway documentation as a user, see [Write for the Community](/contribute/).
- For writing guidelines for the Scaleway console, see the [UX Writing Guide](https://ultraviolet.scaleway.com/6dd9b5c45/p/54f238-ux-writing-guide).
- For Scaleway design and branding guidelines, see [Ultraviolet](https://ultraviolet.scaleway.com/6dd9b5c45/p/62b4e2-ultraviolet).

## Suggest an edit

Follow this guided tour to discover how to suggest edits to the documentation website.
<GuideFlow src="https://app.guideflow.com/player/mk6jyj0aqr"/>

## Overall writing guidelines

### Language
Expand Down