Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Revise contribution and documentation overview #1265

Merged
merged 1 commit into from
Feb 4, 2025
Merged

docs: Revise contribution and documentation overview #1265

merged 1 commit into from
Feb 4, 2025

Conversation

sasa-tomic
Copy link
Member

Key Changes

Contributing Guide Updates:

  • Reorganized the contributing guide for better clarity and flow.
  • Enhanced sections on setting up the development environment and troubleshooting.
  • Included detailed instructions for environment setup, focusing on Python (Rye), Rust, Node.js, and Yarn.
  • Added pre-commit hooks and expanded IDE configuration instructions.

Project Overview and Documentation:

  • Elaborated on DRE components and introduced a structured introduction in the index.
  • Enumerated DRE features, structure, and resources to facilitate onboarding.
  • Consolidated links to key resources and documentation updates, enhancing navigability.

New NNS Motion Proposals Guide:

  • Added a detailed guide on submitting NNS motion proposals explicitly outlining prerequisites, forum collaboration needs, authentication methods, and command usage.
  • Provided best practices for proposal crafting and engagement strategies.

MkDocs Configuration Enhancements:

  • Reorganized MkDocs navigation to align with updated documentation structure.
  • Enhanced the theme customization and feature set.
  • Included new extensions for improved styling and function.
  • Implemented a social link and consent prompt feature within documentation extras.

@sasa-tomic
docs: update contributing guide and index
249a54c 
### Changes in Contributing Guide

- Revamped the setup instructions for contributing to the DRE project.
- Added a comprehensive table of contents.
- Detailed development environment setup using Rye.
- Provided IDE configuration guidelines.
- Introduced troubleshooting tips for Rye.
- Expanded on pre-commit hooks installation.
- Optional Rust development setup and system dependencies detailed for Linux and macOS.
- Node.js and Yarn setup instructions for frontend development.
- Defined the overall project structure and development workflow process.

### Updates to Documentation Index

- Provided a comprehensive overview of Decentralized Reliability Engineering (DRE).
- Defined key components such as DRE CLI Tool, Internal DRE Dashboard, Service Discovery, and Log Management.
- Introduced sections on core features like Release Management, Subnet Management, and Monitoring.
- Enhanced quick links for better navigation of documentation resources.
- Added resources and licensing information.

### New Guide

- **Submitting NNS Motion Proposals**:
  - A detailed guide on how to submit motion proposals using the DRE CLI.
  - Included prerequisites, proposal components, and command line usage.
  - Provided forum discussion requirements and authentication options.
  - Added best practices, troubleshooting, and resource links.

### MkDocs Configuration

- Updated site name, description, and authoring details.
- Reorganized navigation structure to improve documentation accessibility.
- Enhanced theme features with updated palettes and icons.
- Expanded markdown extensions and improved search functionality.
- Updated extra JavaScript and CSS for better performance.
@sasa-tomic sasa-tomic requested a review from a team as a code owner February 4, 2025 12:55
@sasa-tomic sasa-tomic self-assigned this Feb 4, 2025
DFINITYManu
DFINITYManu approved these changes Feb 4, 2025
View reviewed changes
Copy link
Contributor

@DFINITYManu DFINITYManu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow man this is very good.

pietrodimarco-dfinity
pietrodimarco-dfinity approved these changes Feb 4, 2025
View reviewed changes
Copy link
Contributor

@pietrodimarco-dfinity pietrodimarco-dfinity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you :) Very good change

@sasa-tomic sasa-tomic merged commit c211ebd into main Feb 4, 2025
5 checks passed
@sasa-tomic sasa-tomic deleted the docs/update-contributing-and-index branch February 4, 2025 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pietrodimarco-dfinity pietrodimarco-dfinity pietrodimarco-dfinity approved these changes

@DFINITYManu DFINITYManu DFINITYManu approved these changes

Assignees

@sasa-tomic sasa-tomic

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sasa-tomic @DFINITYManu @pietrodimarco-dfinity