Skip to content

Comments

add comprehensive documentation (core, develop, functions, technical guide, contributor guide)#9537

Merged
tremor021 merged 1 commit intomainfrom
internal_docs
Dec 1, 2025
Merged

add comprehensive documentation (core, develop, functions, technical guide, contributor guide)#9537
tremor021 merged 1 commit intomainfrom
internal_docs

Conversation

@MickLesk
Copy link
Member

@MickLesk MickLesk commented Dec 1, 2025

✍️ Description

Introduces multiple new documentation files covering system defaults, development/debugging modes, exit codes, technical references, API usage, contribution guidelines, container and install guides, and function library references. This provides detailed guidance for users and contributors on configuration, troubleshooting, development workflows, and best practices.

As next Step - we remove the .github/CONTRI* Files and modify the Readme for Contributor.

✅ 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.

Introduces multiple new documentation files covering system defaults, development/debugging modes, exit codes, technical references, API usage, contribution guidelines, container and install guides, and function library references. This provides detailed guidance for users and contributors on configuration, troubleshooting, development workflows, and best practices.
@MickLesk MickLesk requested a review from a team as a code owner December 1, 2025 11:44
@github-actions github-actions bot added the maintenance Code maintenance or general upkeep of the project label Dec 1, 2025
@MickLesk MickLesk changed the title add comprehensive documentation add comprehensive documentation (core, develop, functions, technical guide, contributor guide) Dec 1, 2025
@MickLesk MickLesk added organization Issues relating to the community-scripts Github organization github and removed maintenance Code maintenance or general upkeep of the project labels Dec 1, 2025
@tremor021 tremor021 merged commit 1294b89 into main Dec 1, 2025
2 checks passed
@MickLesk MickLesk added the maintenance Code maintenance or general upkeep of the project label Dec 1, 2025
probers1 pushed a commit to probers1/ProxmoxVE that referenced this pull request Dec 5, 2025
@MickLesk MickLesk deleted the internal_docs branch December 8, 2025 07:52
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 3, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

github maintenance Code maintenance or general upkeep of the project organization Issues relating to the community-scripts Github organization

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants