Blålange Documentation

website·Indexed 31 days ago

https://docs.blalange.org/

Comprehensive guides and documentation for Blålange projects, featuring a style guide for visual consistency (including IBM Plex Sans typography, color palettes, and logo usage) and a code guide covering technical standards, Conventional Commits, and development environment setup.

Tokens: 3.6K
Snippets: 8
Records: 25
Agent score: 47%

What's inside Blålange

Overview of Blålange Code Guide
The Blålange Code Guide establishes technical standards, code conventions, and best practices applied across all Blålange projects. Its primary goals are to ensure codebase consistency, improve code quality, facilitate developer collaboration, reduce onboarding time for new members, and minimize technical debt.
https://docs.blalange.org/en/docs/code-guide/overview/
Overview of Blålange Code Guide standards
The Blålange code guide establishes technical standards, code conventions, and best practices applied across all Blålange projects. Its primary goals are to ensure codebase consistency, improve code quality, facilitate developer collaboration, reduce onboarding time for new members, and minimize technical debt.
https://docs.blalange.org/docs/code-guide/overview/
Overview of the Blålange Style Guide
The Blålange style guide provides comprehensive guidelines to maintain visual consistency across all Blålange projects. It is organized into three main categories: Logo usage, Color palettes (primary, secondary, and accent colors), and Typography (font selection, sizes, weights, and line spacing).
https://docs.blalange.org/en/docs/style-guide/overview/
Overview of Blålange project documentation
Blålange provides comprehensive guides and documentation for all its projects, organized into two primary technical resources: a Style Guide (covering visual identity, branding guidelines, and design principles) and a Code Guide (covering technical standards, code conventions, and best practices used across all projects).
https://docs.blalange.org/en/docs/intro/
Overview of Blålange project documentation
The Blålange documentation site provides comprehensive guides and technical standards for all Blålange projects. It is divided into two primary knowledge bases: the Style Guide (covering visual identity, branding guidelines, and design principles) and the Code Guide (covering technical standards, code conventions, and best practices).
https://docs.blalange.org/docs/intro/
Overview of Blålange Style Guide
The Blålange style guide provides comprehensive guidelines to maintain visual consistency across all Blålange projects. It is organized into three main categories: Logo usage, Color palettes (primary, secondary, and accent colors), and Typography (font selection, sizes, weights, and line spacing).
https://docs.blalange.org/docs/style-guide/overview/
Blålange Code Guide Structure
The Blålange Code Guide is organized into four main categories:
- General: Fundamental principles for all code, including inclusive language guidelines and overall coding standards.
- Development Environment and Tools: Recommended tools, editors, and environment setups to ensure efficiency and consistency.
- Formatting: Guidelines for code formatting and plans for future automated formatting.
- Commits: Detailed guidelines for writing commit messages using the Conventional Commits format.
https://docs.blalange.org/en/docs/code-guide/overview/
Contribute to Blålange documentation
The Blålange documentation is maintained by the Blålange team. Developers wishing to contribute improvements or fixes can do so via the official GitHub repository.
```
# Visit the repository to contribute
https://github.com/blalange/docs
```
https://docs.blalange.org/en/docs/intro/
Blålange Code Guide structure and categories
The Blålange code guide is organized into four main categories:
1. General: Basic principles for all code, including inclusive language guidelines and overall coding standards.
2. Development Environment and Tools: Recommended tools, editors, and environment setups to ensure efficiency and consistency.
3. Formatting: Guidelines for code formatting and plans for future automated formatting.
4. Commits: Detailed guidelines for writing commit messages using the Conventional Commits format.
https://docs.blalange.org/docs/code-guide/overview/
Use inclusive language in code and documentation
Avoid using words that can be perceived as offensive or exclusionary. Replace legacy technical terms with neutral, descriptive alternatives to ensure the codebase and documentation are inclusive.
```
Avoid: master/slave       -> Use: primary/secondary
Avoid: blacklist/whitelist -> Use: blocklist/allowlist
```
https://docs.blalange.org/en/docs/code-guide/general/
Select the correct Blålange logo variation based on background
The Blålange logo must be used consistently across all platforms. The choice of logo variation depends on the background color of the material:
- Standard Logo: The primary version and the preferred choice for dark backgrounds.
- Logo with Outline: Used on light backgrounds instead of the standard logo.
- White Logo with Outline: Specifically designed for use on light backgrounds.
https://docs.blalange.org/en/docs/style-guide/logo/
Contribute to Blålange documentation
Blålange documentation is maintained by the Blålange team. Developers and contributors can suggest improvements or submit fixes via the official GitHub repository.
```
# Visit the repository to contribute
https://github.com/blalange/docs
```
https://docs.blalange.org/docs/intro/