Skip to content

Commit fcfc6dc

Browse files
✨ feat(repo): enhance README and add contributing guidelines
1 parent 4723d97 commit fcfc6dc

2 files changed

Lines changed: 68 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to Spraxium Docs
2+
3+
Thank you for taking the time to improve the documentation. This guide covers the standards and conventions that all content contributions should follow.
4+
5+
## Getting Started
6+
7+
1. Fork this repository and create a branch from `main`.
8+
2. Make your changes following the standards described below.
9+
3. Open a pull request with a clear description of what was changed and why.
10+
11+
## Language and Tone
12+
13+
Write in a direct, practical tone focused on what the developer needs to know to use the feature. Avoid explaining how the framework works internally. The reader is a consumer of the API, not a contributor to the core.
14+
15+
Avoid repeating the same word or phrase in close succession within a page, and keep descriptions concise. Every sentence should add information.
16+
17+
## Accentuation and Encoding
18+
19+
Apply correct accentuation in Portuguese and Spanish content. Never use corrupted characters or incorrect substitutions caused by encoding issues. If you notice any visual inconsistency in accented characters, correct it manually before submitting.
20+
21+
## Code in Documentation
22+
23+
All code-related content, including variable names, function names, class names, file names, and code blocks, must remain in English regardless of the language the surrounding documentation is written in.
24+
25+
Inline code blocks should be used sparingly. Reserve them for cases where there is genuine semantic need, such as identifying an exact function name or a CLI command. For general technical terms and highlights, prefer italics.
26+
27+
For longer examples, use tabbed code blocks when showing multiple variations, or place code inside a dropdown when a contextual explanation is needed alongside it. Avoid large standalone code blocks.
28+
29+
## Lists and Tables
30+
31+
For lists that require per-item explanations, prefer dropdown components or ordered and unordered lists over tables. Tables can be hard to scan and do not scale well with detailed content.
32+
33+
## Callouts
34+
35+
Use callouts strategically to highlight tips, important notes, or supplementary information. Do not overuse them, but do not avoid them either. Every callout should contain at least two lines of content to ensure it adds real value.
36+
37+
## Steps
38+
39+
Step components may include code blocks. Always place the code block below the step description, never above it.
40+
41+
## Navigation Footer
42+
43+
The final navigation link at the bottom of each page (next page, next topic, or equivalent in other languages) must be a single link with no description. Use the following format:
44+
45+
```
46+
## Next
47+
48+
[Page title](url)
49+
```
50+
51+
Do not add descriptions like "This page covers..." or "Read next..." next to navigation links.
52+
53+
## Submitting a Pull Request
54+
55+
- Keep each PR focused on a single topic or fix. Avoid combining unrelated changes.
56+
- If you are fixing an inconsistency, describe what was wrong and what the correct form should be.
57+
- If you are adding new content, make sure it follows all the standards above before opening the PR.
58+
- Content is rendered at [spraxium.com/guide](https://spraxium.com/guide).

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# spraxium/docs
22

3-
Public documentation content for [Spraxium](https://spraxium.dev).
3+
This repository contains the public documentation content for [Spraxium](https://spraxium.com/guide), a TypeScript framework for building Discord bots.
4+
5+
The framework is currently at version **0.1.0**. The documentation has gone through several revision cycles, but may still contain inconsistencies or inaccuracies. If you find anything that looks wrong or unclear, contributions are welcome via pull request.
46

57
## Structure
68

79
```
8-
guide/ → framework guides (MDX)
10+
en/ → English content (MDX)
11+
pt/ → Portuguese content (MDX)
12+
es/ → Spanish content (MDX)
913
changelogs/ → version changelogs (MDX)
14+
roadmap/ → public roadmap entries
1015
```
1116

17+
Each language folder mirrors the same category structure: getting-started, configuration, slash-commands, prefix-commands, listeners, guards, components, modals, http, i18n, schedule, signal, env, logger, presence, exceptions, sharding, and cli.
18+
1219
## Contributing
1320

14-
Pull requests are welcome. Content is rendered at [spraxium.dev/guide](https://spraxium.dev/guide).
21+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full contribution guide.

0 commit comments

Comments
 (0)