Skip to content

Conversation

dannywillems
Copy link
Member

No description provided.

Copy link
Contributor

@0xMimir 0xMimir left a comment

Choose a reason for hiding this comment

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

LGTM

@dannywillems dannywillems merged commit 6b76cff into develop Sep 11, 2025
57 of 60 checks passed
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR significantly improves the documentation website by adding comprehensive node management guides and API documentation. The changes introduce new documentation sections for node operators and developers, with expanded guides covering Docker usage, archive nodes, and API references.

  • Adds comprehensive node management documentation with commands for monitoring, troubleshooting, and maintenance
  • Creates new "APIs and Data" section with detailed GraphQL API and archive database query documentation
  • Updates existing guides with better Docker Compose workflows and frontend status warnings

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
website/sidebars.ts Adds node management guide and new "APIs and Data" documentation section
website/docs/node-operators/node-management.md New comprehensive guide for node management commands and troubleshooting
website/docs/node-operators/docker-usage.md Enhanced Docker usage guide with updated workflows and frontend warnings
website/docs/node-operators/block-producer.md Improved block producer setup with direct Docker Compose file downloads
website/docs/node-operators/archive-node.md Expanded archive node documentation with better explanations and data analysis guides
website/docs/node-operators/alpha-testing.md Updated testing guide with frontend status warnings
website/docs/developers/graphql-api.md New comprehensive GraphQL API reference documentation
website/docs/developers/docker-images.md Updated with frontend status information
website/docs/developers/archive-database-queries.md New detailed guide for SQL queries and database analysis
Makefile Enhanced documentation server configuration with configurable port
CLAUDE.md Added formatting guidelines for Docusaurus admonitions
.github/workflows/docker.yaml Added Docker image build-info verification testing
.github/workflows/ci.yaml Added build-info command verification to CI

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.


:::tip

Best Practice Always fix file ownership after Docker operations to ensure your
Copy link

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

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

Missing colon after 'Best Practice'. Should be 'Best Practice:' to follow standard admonition formatting.

Suggested change
Best Practice Always fix file ownership after Docker operations to ensure your
Best Practice: Always fix file ownership after Docker operations to ensure your

Copilot uses AI. Check for mistakes.

Comment on lines +84 to +88
:::warning Required Configuration The archive node requires a `.env` file
with PostgreSQL database settings. The example above provides the minimum
required configuration. You can customize the database password and other
settings as needed. :::
Copy link

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

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

Missing line break after 'Required Configuration'. The admonition title should be on its own line: ':::warning Required Configuration'.

Suggested change
:::warning Required Configuration The archive node requires a `.env` file
with PostgreSQL database settings. The example above provides the minimum
required configuration. You can customize the database password and other
settings as needed. :::
:::warning Required Configuration
The archive node requires a `.env` file with PostgreSQL database settings. The example above provides the minimum required configuration. You can customize the database password and other settings as needed.
:::

Copilot uses AI. Check for mistakes.


# Or connect from within the Docker environment
# Note: postgres-mina-rust is the container name from the archive node setup
# See: https://o1-labs.github.io/mina-rust/node-operators/archive-node
Copy link

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

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

The URL reference uses 'o1-labs.github.io' which may not be the correct documentation domain. This should be verified to ensure it points to the actual deployed documentation site.

Suggested change
# See: https://o1-labs.github.io/mina-rust/node-operators/archive-node
# See: https://docs.minaprotocol.com/node-operators/archive-node

Copilot uses AI. Check for mistakes.

@dannywillems dannywillems deleted the dw/website-more-doc branch October 16, 2025 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants