Skip to content

docs: expand style guide, add CONTRIBUTING.md, clarify line-length policy#14580

Open
Copilot wants to merge 4 commits intomasterfrom
copilot/expand-style-guide-and-add-contributing
Open

docs: expand style guide, add CONTRIBUTING.md, clarify line-length policy#14580
Copilot wants to merge 4 commits intomasterfrom
copilot/expand-style-guide-and-add-contributing

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 24, 2026

Overview

This PR expands and improves the Nextcloud documentation contributor guidelines and style standards.

Changes

1. Enhanced Style Guide (style_guide.rst)

  • Expanded documentation with clearer formatting and writing standards
  • Clarified line-length policy for better consistency across documentation
  • Improved PHP code examples with proper context and array demonstrations
  • Fixed sudo command syntax: sudo -u www-data php occsudo -E -u www-data php occ

2. New Contributor Guide (CONTRIBUTING.md)

  • Added comprehensive contributor guidelines for the documentation repository
  • Provides clear onboarding for new documentation contributors

3. Communication Updates

  • Updated communication channels from Matrix/IRC to Nextcloud Talk
  • Added cross-manual linking rules to improve documentation navigation

Why This Matters

  • Better contributor experience: Clear guidelines make it easier for people to contribute high-quality documentation
  • Consistency: Expanded style guide ensures uniform documentation across the project
  • Accessibility: Updated communication channels reflect current Nextcloud community practices
  • Quality: Improved examples and clarified syntax reduce errors in documentation

Files Modified

  • style_guide.rst - Updated with expanded guidelines, clarified line-length policy, and corrected PHP examples
  • CONTRIBUTING.md - New file with comprehensive contributor guidelines
  • Communication channel references - Updated to use Nextcloud Talk

Copilot AI and others added 2 commits April 24, 2026 13:20
Agent-Logs-Url: https://github.com/nextcloud/documentation/sessions/a4983ff4-37de-4c58-b6a1-704f13e422df

Co-authored-by: nextcloud-command <88102737+nextcloud-command@users.noreply.github.com>
Agent-Logs-Url: https://github.com/nextcloud/documentation/sessions/a1e48a5d-fb5c-4031-bb01-cb2b3b3760c6

Co-authored-by: nextcloud-command <88102737+nextcloud-command@users.noreply.github.com>
Agent-Logs-Url: https://github.com/nextcloud/documentation/sessions/64d78f60-de8d-43cc-8ba6-41f750424257

Co-authored-by: nextcloud-command <88102737+nextcloud-command@users.noreply.github.com>
Comment thread CONTRIBUTING.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants