Skip to content
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.

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

Write documentation on how to use the mod and how to use the content pack systems #161

Open
MarkenJaden opened this issue Jun 25, 2024 · 0 comments

Comments

@MarkenJaden
Copy link
Member

Organize the documentation in a clean and reliable way

MarkenJaden added a commit that referenced this issue Jun 25, 2024
Related to #161

Update documentation to enhance mod usage and content pack creation guidance.

- **README.md**: Minor update to the UniversalModCore link, maintaining the original content structure without adding the planned detailed instructions or Discord links.
- **docs/index.md**: Overhauls the documentation index page, introducing a structured table of contents, installation guide, mod usage, content pack creation for V1 and V2, advanced configuration, troubleshooting, contributing, and community support sections.
- **Adds new documentation files**:
  - `docs/HowToUse.md`: Provides comprehensive step-by-step instructions for mod installation, configuration, usage, and content pack creation, including community support links.
  - `docs/ContentPacksV1.md` and `docs/ContentPacksV2.md`: Offer detailed guides on creating content packs for different versions of the mod, including structure, asset organization, and best practices.


---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/LandOfRails/LandOfSignals/issues/161?shareId=7fffa40e-a198-43a8-9246-fc09da1edc92).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant