Skip to content

Commit 0d435a3

Browse files
Add missing plugins and reorganize to fit mkdocs structure better
1 parent 6372dd1 commit 0d435a3

27 files changed

+93
-277
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,3 @@
11
# Contributing to Grout
22

3-
First off, thank you for considering contributing to Grout! We appreciate your time and effort.
4-
5-
Before implementing major features, please open an issue or discuss it in the
6-
[Grout Development Channel](https://discord.com/channels/1138838206532554853/1456747141518069906) on the
7-
[RomM Discord](https://discord.gg/P5HtHnhUDH) to ensure alignment with the project's direction.
8-
9-
## Code of Conduct
10-
11-
By contributing, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful, constructive, and
12-
welcoming to all contributors regardless of experience level.
13-
14-
## Ways to Contribute (No Coding Required)
15-
16-
Not a developer? There are many ways to help improve Grout!
17-
18-
### Translations
19-
20-
Help make Grout accessible to more users by translating it into your language. Translation files are located in `resources/locales/`.
21-
22-
See the [Development Guide](/old_docs/DEVELOPMENT.md#internationalization-i18n) for details on the i18n workflow.
23-
24-
### Testing & Bug Reports
25-
26-
- Test Grout on your device and CFW combination
27-
- Report bugs with detailed reproduction steps
28-
- Verify fixes in pre-release builds
29-
- Test edge cases (slow networks, large libraries, etc.)
30-
31-
### Documentation
32-
33-
- Fix typos and improve clarity in guides
34-
- Write tutorials for specific use cases
35-
- Add screenshots or animated demos
36-
- Translate documentation
37-
38-
### Platform Mapping Updates
39-
40-
Help keep CFW platform directory mappings current:
41-
- Report incorrect or missing platform mappings for your CFW
42-
- Test new CFW releases and note any directory structure changes
43-
44-
### Community Support
45-
46-
- Help answer questions in the [RomM Discord](https://discord.gg/P5HtHnhUDH)
47-
- Share tips and workflows with other users
48-
- Welcome new community members
49-
50-
---
51-
52-
## Getting Started (Developers)
53-
54-
1. Read the [Development Guide](/old_docs/DEVELOPMENT.md) for setup instructions
55-
2. Fork and clone the repository
56-
3. Create a feature branch from `main` with a descriptive name (e.g., `feature/add-search-filter`)
57-
4. Make your changes
58-
5. Test locally on your target CFW if possible
59-
6. Commit with clear, descriptive messages
60-
7. Push and open a pull request against `main`
61-
62-
## Pull Request Standards
63-
64-
- Follow existing code conventions and patterns
65-
- Test your changes locally before submitting
66-
- Update documentation if your changes affect user-facing behavior
67-
- Ensure the build passes (`task build` or `go build ./...`)
68-
- Provide a clear description of what your PR does and why
69-
70-
## Code Style
71-
72-
We use standard Go formatting and conventions:
73-
74-
- Run `go fmt` before committing
75-
- Use `go vet` and `staticcheck` to catch issues
76-
- Follow existing patterns in the codebase for consistency
77-
78-
## Reporting Bugs
79-
80-
Please [create an issue](https://github.com/rommapp/grout/issues/new/choose) with:
81-
82-
- Your CFW and version (muOS, Knulli, Spruce, NextUI)
83-
- Grout version
84-
- Steps to reproduce the issue
85-
- Expected vs actual behavior
86-
- Any relevant logs or screenshots
87-
88-
## License
89-
90-
By contributing, you agree that your contributions will be licensed under the MIT License.
3+
For contribution guidelines, please see our documentation: https://grout.romm.app/development/

docs/development/development.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@
44
These instructions were written with macOS in mind. It should work elsewhere, but we have
55
not personally verified this.
66

7-
We hang out over in
8-
the [Grout Development Channel](https://discord.com/channels/1138838206532554853/1456747141518069906) on
9-
the [RomM Discord](https://discord.gg/P5HtHnhUDH). Come join us!
10-
11-
---
7+
We hang out over in the [Grout Development Channel](https://discord.com/channels/1138838206532554853/1456747141518069906) on the [RomM Discord](https://discord.gg/P5HtHnhUDH). Come join us!
128

139
## Prerequisites
1410

@@ -27,8 +23,6 @@ brew install sdl2 sdl2_image sdl2_ttf sdl2_gfx
2723
- [Docker Desktop](https://www.docker.com/products/docker-desktop/) or equivalent
2824
- We love [OrbStack](https://orbstack.dev) (not a sponsor)
2925

30-
---
31-
3226
## Getting Started
3327

3428
1. Clone the [Grout](https://github.com/rommapp/grout) repository.
@@ -44,8 +38,6 @@ brew install sdl2 sdl2_image sdl2_ttf sdl2_gfx
4438
muOS). Have the subdirectory structure of this path match the CFW you are working on.
4539
5. Run / Debug `app/grout.go`, making sure to reference the `.env` file in your run configuration.
4640

47-
---
48-
4941
## Project Structure
5042

5143
The codebase is laid out fairly well. It attempts to keep everything grouped by feature / function / domain.
@@ -67,8 +59,6 @@ The codebase is laid out fairly well. It attempts to keep everything grouped by
6759
- `version` exposes the version information that is injected at build time. Having it as its own package made the script
6860
cleaner.
6961

70-
---
71-
7262
## Packaging
7363

7464
The `taskfile.yml` defines scripts for building and packaging Grout for various CFWs. All builds target ARM64 Linux
@@ -110,7 +100,7 @@ into the appropriate directory structure for that CFW.
110100

111101
### Deployment via ADB
112102

113-
For rapid testing, you can deploy directly to a connected device:
103+
For rapid testing, you can deploy directly to a connected device, assuming that the device has ADB available:
114104

115105
```shell
116106
# NextUI (TrimUI devices)
@@ -153,8 +143,6 @@ build/
153143
└── Spruce/Grout/ # Spruce package
154144
```
155145

156-
---
157-
158146
## Helper Tools
159147

160148
The `taskfile.yml` includes several utility tasks for common development workflows.
Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
# Contributing to Grout
22

3-
First off, thank you for considering contributing to Grout! We appreciate your time and effort.
3+
Thank you for considering contributing to Grout! We appreciate your time and effort.
44

55
Before implementing major features, please open an issue or discuss it in the
66
[Grout Development Channel](https://discord.com/channels/1138838206532554853/1456747141518069906) on the
77
[RomM Discord](https://discord.gg/P5HtHnhUDH) to ensure alignment with the project's direction.
88

99
## Code of Conduct
1010

11-
By contributing, you agree to uphold our Code of Conduct. Be respectful, constructive, and
12-
welcoming to all contributors regardless of experience level.
11+
By contributing, you agree to uphold our [Code of Conduct](https://github.com/rommapp/grout/blob/main/.github/CODE_OF_CONDUCT.md).
1312

14-
## Ways to Contribute (No Coding Required)
13+
Be respectful, constructive, and welcoming to all contributors regardless of experience level.
14+
15+
## Ways to Contribute
1516

1617
Not a developer? There are many ways to help improve Grout!
1718

@@ -48,8 +49,6 @@ Help keep CFW platform directory mappings current:
4849
- Share tips and workflows with other users
4950
- Welcome new community members
5051

51-
---
52-
5352
## Getting Started (Developers)
5453

5554
1. Read the [Development Guide](development.md) for setup instructions

docs/development/kudos.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Thank you to everyone who has contributed to Grout!
44

5-
## ~~Fearful Leader~~ Maintainer
5+
## ~~Fearful Leader~~ Lead Maintainer { data-toc-label="Lead Maintainer" }
66

77
- **Brandon T. Kowalski** ([@BrandonKowalski](https://github.com/BrandonKowalski))
88

@@ -13,11 +13,3 @@ Thank you to everyone who has contributed to Grout!
1313
- **Huynh Duc Dung** ([@jellydn](https://github.com/jellydn))
1414
- **Sargun Vohra** ([@sargunv](https://github.com/sargunv))
1515
- **Zach Keatings** ([@zkeatings](https://github.com/zkeatings))
16-
17-
---
18-
19-
### Spread Joy!
20-
21-
A significant amount of time has been spent building Grout.
22-
23-
If you enjoy using Grout and feel inclined to pay it forward, go do something nice for someone!

docs/development/state-machine.md

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# State Machine
1+
# State Machine Reference
22

33
This document shows the navigation flow between screens in Grout.
44

@@ -147,33 +147,3 @@ flowchart TD
147147
| Logout Confirmation | Confirm logout action |
148148
| Save Sync | Manual save synchronization |
149149
| BIOS Download | Download BIOS files |
150-
151-
---
152-
153-
## Navigation State
154-
155-
The FSM maintains state in a `NavState` struct:
156-
157-
```go
158-
type NavState struct {
159-
CurrentGames []romm.Rom
160-
FullGames []romm.Rom
161-
SearchFilter string
162-
HasBIOS bool
163-
GameListPos ListPosition
164-
165-
CollectionSearchFilter string
166-
CollectionGames []romm.Rom
167-
CollectionListPos ListPosition
168-
CollectionPlatformPos ListPosition
169-
170-
PlatformListPos ListPosition
171-
172-
SettingsPos ListPosition
173-
CollectionsSettingsPos ListPosition
174-
AdvancedSettingsPos ListPosition
175-
176-
QuitOnBack bool
177-
ShowCollections bool
178-
}
179-
```

docs/getting-started/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Enter your connection details:
4040
Press `Start` to connect.
4141

4242
!!! tip
43-
Using a self-signed certificate? Set **SSL Certificates** to **Skip Verification**.
43+
Using a self-signed certificate? Set **SSL Certificates** to **Skip Verification**.
4444

4545
### Step 4: Map Your Platforms
4646

@@ -49,6 +49,7 @@ Tell Grout where to save games for each platform:
4949
- **Skip** - Don't download games for this platform
5050
- **Create {Directory}** - Let Grout create a new folder
5151
- **/{Existing Directory}** - Use an existing folder
52+
- **Custom** - Specify a custom path
5253

5354
Press `Start` when done.
5455

@@ -64,6 +65,6 @@ That's it! Your game is now on your device.
6465

6566
## What's Next?
6667

67-
- [Full User Guide](../guide/user-guide.md) - Complete feature documentation
68-
- [Settings Reference](../guide/settings.md) - Configure Grout to your preferences
69-
- [Save Sync Guide](../guide/save-sync.md) - Keep saves synchronized across devices
68+
- [Full User Guide](../usage/guide.md) - Complete feature documentation
69+
- [Settings Reference](../usage/settings.md) - Configure Grout to your preferences
70+
- [Save Sync Guide](../usage/save-sync.md) - Keep saves synchronized across devices

docs/getting-started/install-knulli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,4 @@ file if you do not want to authenticate again, and configure platforms folder ma
4545

4646
## Next Steps
4747

48-
After installation is complete, check out the [User Guide](../guide/user-guide.md) to learn how to use Grout.
48+
After installation is complete, check out the [User Guide](../usage/guide.md) to learn how to use Grout.

docs/getting-started/install-muos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ sure to keep the `config.json` file if you do not want to authenticate again, an
4343

4444
## Next Steps
4545

46-
After installation is complete, check out the [User Guide](../guide/user-guide.md) to learn how to use Grout.
46+
After installation is complete, check out the [User Guide](../usage/guide.md) to learn how to use Grout.

docs/getting-started/install-nextui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ file if you do not want to authenticate again, and configure platforms folder ma
5353

5454
## Next Steps
5555

56-
After installation is complete, check out the [User Guide](../guide/user-guide.md) to learn how to use Grout.
56+
After installation is complete, check out the [User Guide](../usage/guide.md) to learn how to use Grout.

docs/getting-started/install-rocknix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ file if you do not want to authenticate again, and configure platforms folder ma
4646

4747
## Next Steps
4848

49-
After installation is complete, check out the [User Guide](../guide/user-guide.md) to learn how to use Grout.
49+
After installation is complete, check out the [User Guide](../usage/guide.md) to learn how to use Grout.

0 commit comments

Comments
 (0)