[PR #10921] Update docs #8977

Open
opened 2026-02-05 08:49:21 +03:00 by OVERLORD · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/community-scripts/ProxmoxVE/pull/10921
Author: @MickLesk
Created: 1/18/2026
Status: 🔄 Open

Base: mainHead: update_docs


📝 Commits (10+)

  • ebe0eee Enhance setup-fork.sh with --full mode and misc/ targeting
  • affd9c8 add AI.md
  • 5a97590 fix links in AI.md
  • acdf4db Update contribution docs and templates for best practices
  • 8f23297 Update fetch_and_deploy_gh_release usage in docs and templates
  • 9671c9f Revise contribution docs and update CT template
  • e4ffc47 Update fork and release instructions in contribution docs
  • 7db01be Update GitHub repo placeholders in docs and templates
  • 8677104 Move user submitted guides to guides directory
  • e72c7d8 Update contribution docs for improved workflow and clarity

📊 Changes

15 files changed (+2280 additions, -703 deletions)

View changed files

docs/contribution/AI.md (+868 -0)
📝 docs/contribution/CODE-AUDIT.md (+38 -11)
📝 docs/contribution/CONTRIBUTING.md (+49 -5)
📝 docs/contribution/FORK_SETUP.md (+73 -28)
📝 docs/contribution/GUIDE.md (+88 -82)
📝 docs/contribution/HELPER_FUNCTIONS.md (+48 -42)
📝 docs/contribution/README.md (+344 -45)
📝 docs/contribution/setup-fork.sh (+142 -121)
📝 docs/contribution/templates_ct/AppName.md (+125 -133)
📝 docs/contribution/templates_ct/AppName.sh (+98 -54)
📝 docs/contribution/templates_install/AppName-install.md (+187 -46)
📝 docs/contribution/templates_install/AppName-install.sh (+43 -117)
📝 docs/contribution/templates_json/AppName.json (+17 -11)
📝 docs/contribution/templates_json/AppName.md (+160 -8)
📝 docs/guides/USER_SUBMITTED_GUIDES.md (+0 -0)

📄 Description

✍️ Description

tbd

Fixes #

Prerequisites (X in brackets)

  • Self-review completed – Code follows project standards.
  • Tested thoroughly – Changes work as expected.
  • No security risks – No hardcoded secrets, unnecessary privilege escalations, or permission issues.

🛠️ Type of Change (X in brackets)

  • 🐞 Bug fix – Resolves an issue without breaking functionality.
  • New feature – Adds new, non-breaking functionality.
  • 💥 Breaking change – Alters existing functionality in a way that may require updates.
  • 🆕 New script – A fully functional and tested script or script set.
  • 🌍 Website update – Changes to website-related JSON files or metadata.
  • 🔧 Refactoring / Code Cleanup – Improves readability or maintainability without changing functionality.
  • 📝 Documentation update – Changes to README, AppName.md, CONTRIBUTING.md, or other docs.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/community-scripts/ProxmoxVE/pull/10921 **Author:** [@MickLesk](https://github.com/MickLesk) **Created:** 1/18/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `update_docs` --- ### 📝 Commits (10+) - [`ebe0eee`](https://github.com/community-scripts/ProxmoxVE/commit/ebe0eeef8e1347aca73e944de410c202eb041a45) Enhance setup-fork.sh with --full mode and misc/ targeting - [`affd9c8`](https://github.com/community-scripts/ProxmoxVE/commit/affd9c81e1b28540090a2d2b1bf09d174217d4bb) add AI.md - [`5a97590`](https://github.com/community-scripts/ProxmoxVE/commit/5a975901ea037acd990b7d9d7ff4febf814decdc) fix links in AI.md - [`acdf4db`](https://github.com/community-scripts/ProxmoxVE/commit/acdf4dbb2a35d0e9e951bdc8c83401531b4ae738) Update contribution docs and templates for best practices - [`8f23297`](https://github.com/community-scripts/ProxmoxVE/commit/8f23297604f17003f842948e5091ff8366fbaa5d) Update fetch_and_deploy_gh_release usage in docs and templates - [`9671c9f`](https://github.com/community-scripts/ProxmoxVE/commit/9671c9f391507949fe349803e312be2a1567c41b) Revise contribution docs and update CT template - [`e4ffc47`](https://github.com/community-scripts/ProxmoxVE/commit/e4ffc478fb700edb3b05e4871a8672be3540df58) Update fork and release instructions in contribution docs - [`7db01be`](https://github.com/community-scripts/ProxmoxVE/commit/7db01be0a705b3c451fbcc1e7a064ae65d64f919) Update GitHub repo placeholders in docs and templates - [`8677104`](https://github.com/community-scripts/ProxmoxVE/commit/8677104d68eac6b583beb2b0f5324f1a257ef2e3) Move user submitted guides to guides directory - [`e72c7d8`](https://github.com/community-scripts/ProxmoxVE/commit/e72c7d8f7fef8d98ce7c56faa1840683f2f1cd3b) Update contribution docs for improved workflow and clarity ### 📊 Changes **15 files changed** (+2280 additions, -703 deletions) <details> <summary>View changed files</summary> ➕ `docs/contribution/AI.md` (+868 -0) 📝 `docs/contribution/CODE-AUDIT.md` (+38 -11) 📝 `docs/contribution/CONTRIBUTING.md` (+49 -5) 📝 `docs/contribution/FORK_SETUP.md` (+73 -28) 📝 `docs/contribution/GUIDE.md` (+88 -82) 📝 `docs/contribution/HELPER_FUNCTIONS.md` (+48 -42) 📝 `docs/contribution/README.md` (+344 -45) 📝 `docs/contribution/setup-fork.sh` (+142 -121) 📝 `docs/contribution/templates_ct/AppName.md` (+125 -133) 📝 `docs/contribution/templates_ct/AppName.sh` (+98 -54) 📝 `docs/contribution/templates_install/AppName-install.md` (+187 -46) 📝 `docs/contribution/templates_install/AppName-install.sh` (+43 -117) 📝 `docs/contribution/templates_json/AppName.json` (+17 -11) 📝 `docs/contribution/templates_json/AppName.md` (+160 -8) 📝 `docs/guides/USER_SUBMITTED_GUIDES.md` (+0 -0) </details> ### 📄 Description <!--🛑 New scripts must be submitted to [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) for testing. PRs without prior testing will be closed. --> ## ✍️ Description tbd ## 🔗 Related Issue Fixes # ## ✅ Prerequisites (**X** in brackets) - [ ] **Self-review completed** – Code follows project standards. - [ ] **Tested thoroughly** – Changes work as expected. - [ ] **No security risks** – No hardcoded secrets, unnecessary privilege escalations, or permission issues. --- ## 🛠️ Type of Change (**X** in brackets) - [ ] 🐞 **Bug fix** – Resolves an issue without breaking functionality. - [ ] ✨ **New feature** – Adds new, non-breaking functionality. - [ ] 💥 **Breaking change** – Alters existing functionality in a way that may require updates. - [ ] 🆕 **New script** – A fully functional and tested script or script set. - [ ] 🌍 **Website update** – Changes to website-related JSON files or metadata. - [ ] 🔧 **Refactoring / Code Cleanup** – Improves readability or maintainability without changing functionality. - [ ] 📝 **Documentation update** – Changes to `README`, `AppName.md`, `CONTRIBUTING.md`, or other docs. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
OVERLORD added the pull-request label 2026-02-05 08:49:21 +03:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/ProxmoxVE#8977