Setup OP SIG Documentation #1
Open
Conversation
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
- Expand README with Overview, Mission, Scope, and Governance sections - Add owned repositories (qube-manager, bridge-health, zenon-node-monitor) - Add related repositories (go-zenon, qubestr) - Create initiatives framework with dedicated pages - Add OP-001: Initial Setup initiative - Add OP-002: Nostr-Based Network Coordination initiative - Update VitePress config with initiatives sidebar navigation - Simplify Active Initiatives section to link to /initiatives
README is the home page and accessible via site logo, no need in sidebar
There was a problem hiding this comment.
Pull Request Overview
This PR establishes the foundational documentation structure for the OP SIG (Operations Special Interest Group), setting up a comprehensive framework for collaborative development and transparent governance of operational tooling for the Zenon Network ecosystem.
Key Changes:
- Created comprehensive documentation structure including README with mission, scope, and governance sections
- Added two initial initiatives: OP-001 (Initial Setup) and OP-002 (Nostr-Based Network Coordination)
- Configured VitePress navigation to support initiative tracking and documentation
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
README.md |
Comprehensive documentation of OP SIG mission, scope, governance, and owned/related repositories with links to active initiatives |
initiatives/op-001.md |
Documentation for the foundational setup initiative including VitePress configuration, repository organization, and communication channels |
initiatives/op-002.md |
Detailed technical documentation for Nostr-based network coordination system covering qube-manager and qubestr components with implementation phases |
initiatives/README.md |
Initiative tracking page with lifecycle definitions and contribution guidelines |
.vitepress/config.mts |
Navigation configuration adding sidebar items for initiatives and active initiative links |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The OP SIG is an **open working group** under HC1's governance structure. | ||
| All contributors may propose, review, and discuss changes through GitHub issues or pull requests. | ||
|
|
||
| Governance follows the guidelines and decision making framework established by the [SDLC SIG](https://github.com/hypercore-one/sig-sdlc). |
There was a problem hiding this comment.
The compound adjective "decision making" should be hyphenated when modifying "framework". It should be "decision-making framework".
Suggested change
| Governance follows the guidelines and decision making framework established by the [SDLC SIG](https://github.com/hypercore-one/sig-sdlc). | |
| Governance follows the guidelines and decision-making framework established by the [SDLC SIG](https://github.com/hypercore-one/sig-sdlc). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.