-
-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Add comprehensive documentation hub #11
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # Sunny Acres Farm Documentation | ||
|
|
||
| Welcome to the comprehensive documentation for the Sunny Acres Farm repository. This documentation helps you understand and effectively use this repository to manage farm operations. | ||
|
|
||
| ## Documentation Structure | ||
|
|
||
| This documentation follows the [Diátaxis](https://diataxis.fr/) framework, organizing content into four types: | ||
|
|
||
| ### 📚 [Tutorials](./tutorials/) | ||
| **Learning-oriented** — Step-by-step lessons for newcomers | ||
|
|
||
| Start here if you're new to the repository. These guides walk you through your first tasks from start to finish. | ||
|
|
||
| - [Getting Started](./tutorials/getting-started.md) | ||
| - [Your First Issue](./tutorials/creating-your-first-issue.md) | ||
| - [Recording Equipment Maintenance](./tutorials/recording-equipment-maintenance.md) | ||
|
|
||
| ### 🔧 [How-To Guides](./how-to/) | ||
| **Task-oriented** — Practical steps to accomplish specific goals | ||
|
|
||
| Use these when you need to complete a specific task or solve a particular problem. | ||
|
|
||
| - [Adding Crop Records](./how-to/add-crop-record.md) | ||
| - [Logging Equipment Maintenance](./how-to/log-equipment-maintenance.md) | ||
| - [Updating Livestock Health Records](./how-to/update-livestock-health.md) | ||
| - [Tracking Compliance Deadlines](./how-to/track-compliance-deadlines.md) | ||
| - [Using GitHub Issues Effectively](./how-to/use-github-issues.md) | ||
|
|
||
| ### 📖 [Reference](./reference/) | ||
| **Information-oriented** — Technical descriptions and specifications | ||
|
|
||
| Consult these for precise details about data formats, fields, and terminology. | ||
|
|
||
| - [Data Dictionary](./reference/data-dictionary.md) | ||
| - [Farm Glossary](./reference/glossary.md) | ||
| - [File Naming Conventions](./reference/naming-conventions.md) | ||
| - [Label Reference](./reference/labels.md) | ||
|
|
||
| ### 💡 [Explanation](./explanation/) | ||
| **Understanding-oriented** — Background, context, and design decisions | ||
|
|
||
| Read these to understand the "why" behind farm operations and repository design. | ||
|
|
||
| - [Farm Operations Overview](./explanation/farm-operations.md) | ||
| - [Seasonal Calendar](./explanation/seasonal-calendar.md) | ||
| - [Repository Design](./explanation/repository-design.md) | ||
| - [Why GitHub for Farm Management](./explanation/why-github.md) | ||
|
|
||
| --- | ||
|
|
||
| ## Quick Navigation | ||
|
|
||
| | I want to... | Go to... | | ||
| |--------------|----------| | ||
| | Learn how to use this repository | [Getting Started Tutorial](./tutorials/getting-started.md) | | ||
| | Complete a specific task | [How-To Guides](./how-to/) | | ||
| | Look up a term or data field | [Reference Section](./reference/) | | ||
| | Understand farm workflows | [Explanation Section](./explanation/) | | ||
| | See farm data | [Main Repository](../) | | ||
|
|
||
| --- | ||
|
|
||
| ## Farm Sections | ||
|
|
||
| The repository organizes farm records into four main sections: | ||
|
|
||
| - **[crops/](../crops/)** — Planting schedules, crop records, and soil data | ||
| - **[livestock/](../livestock/)** — Health records, feeding schedules, and vet logs | ||
| - **[equipment/](../equipment/)** — Maintenance logs, safety inspections, and inventory | ||
| - **[compliance/](../compliance/)** — Grant tracking and certifications | ||
|
|
||
| Each section has its own README with specific documentation. | ||
|
|
||
| --- | ||
|
|
||
| ## Contributing to Documentation | ||
|
|
||
| Found something unclear or missing? See our [Contributing Guide](../CONTRIBUTING.md) to suggest improvements. Documentation improvements follow the same pull request process as any other contribution. | ||
|
|
||
| --- | ||
|
|
||
| **About Sunny Acres Farm** | ||
|
|
||
| This is a 320-acre diversified operation in the Midwest. We grow corn, soybeans, wheat, and alfalfa, and raise beef cattle, dairy cows, sheep, and horses. | ||
|
|
||
| *This is a demo repository for GitHub training. All data is fictional.* | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These links in the documentation hub reference files that don't exist in this PR:
creating-your-first-issue.mdrecording-equipment-maintenance.mdlog-equipment-maintenance.mdupdate-livestock-health.mdtrack-compliance-deadlines.mduse-github-issues.mdfarm-operations.mdrepository-design.mdWhile the PR description mentions these as future work, linking to non-existent files in the main navigation creates broken links. Consider either: (1) creating placeholder files for critical navigation items, (2) commenting out these links with a note that they're planned, or (3) organizing the hub to clearly separate "Available Now" from "Coming Soon" documentation.