d-bis/ProxmoxVE
4
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

Update documentation links and improve clarity across various files

Browse Source
This commit is contained in:
defiQUG
2026-03-02 12:05:31 -08:00
parent c1445f30bf
commit 9e20d471af
15 changed files with 58 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/contribution/FORK_SETUP.md
View File

@@ -53,7 +53,7 @@ Updates links to `github.com/john/my-fork`
## What Gets Updated?
The script updates these documentation files:
- `docs/CONTRIBUTION_GUIDE.md` (4 links)
- `README.md` (4 links)
- `docs/README.md` (1 link)
- `docs/INDEX.md` (3 links)
- `docs/EXIT_CODES.md` (2 links)
@@ -88,7 +88,7 @@ The script updates these documentation files:
4. **Follow the guide**
```bash
cat docs/CONTRIBUTION_GUIDE.md
cat README.md
```
---
@@ -164,12 +164,12 @@ git checkout docs/*.backup
## Next Steps
1. ✅ Run `bash setup-fork.sh`
2. 📖 Read [docs/CONTRIBUTION_GUIDE.md](docs/CONTRIBUTION_GUIDE.md)
2. 📖 Read [README.md](README.md)
3. 🍴 Choose your contribution path:
- **Containers** → [docs/ct/README.md](docs/ct/README.md)
- **Installation** → [docs/install/README.md](docs/install/README.md)
- **VMs** → [docs/vm/README.md](docs/vm/README.md)
- **Tools** → [docs/tools/README.md](docs/tools/README.md)
- **Containers** → [docs/ct/README.md](../ct/README.md)
- **Installation** → [docs/install/README.md](../install/README.md)
- **VMs** → [docs/vm/README.md](../vm/README.md)
- **Tools** → [docs/tools/README.md](../tools/README.md)
4. 💻 Create your feature branch and contribute!
---
@@ -177,9 +177,9 @@ git checkout docs/*.backup
## Questions?
- **Fork Setup Issues?** → See [Troubleshooting](#troubleshooting) above
- **How to Contribute?** → [docs/CONTRIBUTION_GUIDE.md](docs/CONTRIBUTION_GUIDE.md)
- **How to Contribute?** → [README.md](README.md)
- **Git Workflows?** → `cat .git-setup-info`
- **Project Structure?** → [docs/README.md](docs/README.md)
- **Project Structure?** → [docs/README.md](../README.md)
---

8
docs/contribution/README.md
View File

@@ -96,7 +96,7 @@ All scripts and configurations must follow our coding standards to ensure consis
### Available Guides
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Essential coding standards and best practices
- **[CODE_AUDIT.md](CODE_AUDIT.md)** - Code review checklist and audit procedures
- **[CODE-AUDIT.md](CODE-AUDIT.md)** - Code review checklist and audit procedures
- **Container Scripts** - `/ct/` templates and guidelines
- **Install Scripts** - `/install/` templates and guidelines
- **JSON Configurations** - `/json/` structure and format
@@ -118,7 +118,7 @@ All scripts and configurations must follow our coding standards to ensure consis
Before submitting a pull request, ensure your code passes our audit:
**See**: [CODE_AUDIT.md](CODE_AUDIT.md) for complete audit checklist
**See**: [CODE-AUDIT.md](CODE-AUDIT.md) for complete audit checklist
Key points:
- Code consistency with existing scripts
@@ -301,13 +301,13 @@ bash docs/contribution/setup-fork.sh
### For Experienced Developers
1. Review [CONTRIBUTING.md](CONTRIBUTING.md) - Coding standards
2. Review [CODE_AUDIT.md](CODE_AUDIT.md) - Audit checklist
2. Review [CODE-AUDIT.md](CODE-AUDIT.md) - Audit checklist
3. Check templates in `/ct/` and `/install/`
4. Submit PR with confidence
### For Reviewers/Maintainers
1. Use [CODE_AUDIT.md](CODE_AUDIT.md) as review guide
1. Use [CODE-AUDIT.md](CODE-AUDIT.md) as review guide
2. Reference [docs/TECHNICAL_REFERENCE.md](../TECHNICAL_REFERENCE.md) for architecture
3. Check [docs/EXIT_CODES.md](../EXIT_CODES.md) for error handling