Upload files to "docs"
This commit is contained in:
parent
4587ab01b3
commit
2d543fe68c
5 changed files with 842 additions and 0 deletions
42
docs/index.md
Normal file
42
docs/index.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# GemReader Documentation
|
||||
|
||||
Welcome to the GemReader documentation. This collection of documents provides comprehensive information about the application.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
### Getting Started
|
||||
|
||||
- [README](../README.md) - Main project overview, installation, and usage
|
||||
- [Configuration Guide](configuration.md) - How to configure the application
|
||||
|
||||
### User Guides
|
||||
|
||||
- [Navigation & Controls](navigation.md) - Detailed keyboard controls and navigation
|
||||
|
||||
### Development & Building
|
||||
|
||||
- [Building Guide](building.md) - Instructions for building the application for different platforms
|
||||
|
||||
### Technical Documentation
|
||||
|
||||
- [API Documentation](api.md) - Internal API and code structure
|
||||
- [Architecture](architecture.md) - Project architecture and design patterns
|
||||
|
||||
### Contributing
|
||||
|
||||
- [Contribution Guide](../CONTRIBUTING.md) - How to contribute to the project
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Report an Issue](https://github.com/your-repo/gemreader/issues)
|
||||
- [Source Code](https://github.com/your-repo/gemreader)
|
||||
- [Go Documentation](https://pkg.go.dev/gemreader)
|
||||
|
||||
## Need Help?
|
||||
|
||||
If you can't find what you're looking for in these documents:
|
||||
|
||||
1. Check the [README](../README.md) for basic usage information
|
||||
2. Review the [Navigation Guide](navigation.md) for help with controls
|
||||
3. Look at the [Building Guide](building.md) for compilation instructions
|
||||
4. Open an issue in the GitHub repository
|
||||
Loading…
Add table
Add a link
Reference in a new issue