VnPower/PixivFE
1
0
Fork 0
mirror of https://codeberg.org/VnPower/PixivFE synced 2024-12-06 19:16:23 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: include guidelines document

Browse Source
This commit is contained in:
perennial
2024-09-18 02:25:09 +10:00
parent 6778378427
commit a7331357c3
3 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/dev/guidelines.md
+3 -1
View File
@@ -1,6 +1,8 @@
# Guidelines
This file contains guidelines for code development.
# File structure
## Repository structure
- `assets/`: Static files (images, CSS, JS) and site templates.
- `config/`: Handle configurations for the server.
doc/dev/index.md
+5 -3
View File
@@ -19,11 +19,13 @@ The developer documentation is comprised of the following files:
4. [Framework Migration](framework-migration.md): Documentation of the migration from gofiber to net/http. This migration was completed in [release v2.8](https://codeberg.org/VnPower/PixivFE/src/tag/v2.8) (commit [1ac6f40b57](https://codeberg.org/VnPower/PixivFE/src/commit/1ac6f40b57608b1576d9e812698e95958c91c626)).
5. [Helpful Resources](helpful-resources.md): External links to materials and resources that can aid in PixivFE development, including other Pixiv-related projects and tools.
5. [Guidelines](guidelines.md): Guidelines for code development, including the repository file structure.
6. [Roadmap](roadmap.md): Planned features and improvements for PixivFE, categorized by implementation status and priority.
6. [Helpful Resources](helpful-resources.md): External links to materials and resources that can aid in PixivFE development, including other Pixiv-related projects and tools.
7. [Testing](testing.md): Information about the current state of testing in PixivFE and considerations for future testing strategies.
7. [Roadmap](roadmap.md): Planned features and improvements for PixivFE, categorized by implementation status and priority.
8. [Testing](testing.md): Information about the current state of testing in PixivFE and considerations for future testing strategies.
## Features in Development
mkdocs.yml
+1
View File
@@ -19,6 +19,7 @@ nav:
- "Coding tips": "dev/coding-tips.md"
- "Design flaws": "dev/design-flaws.md"
- "Feature ideas": "dev/feature-ideas.md"
- "Guidelines": "dev/guidelines.md"
- "Helpful resources": "dev/helpful-resources.md"
- "Roadmap": "dev/roadmap.md"
- "Testing": "dev/testing.md"