Docusaurus website #1234
Merged
Docusaurus website #1234
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
dannywillems
force-pushed
the
dw/docs-docusaurus
branch
16 times, most recently
from
ea569e8 to
07fc0be
Compare
dannywillems
force-pushed
the
dw/docs-docusaurus
branch
2 times, most recently
from
f13c2b4 to
891add7
Compare
- Add check-trailing-whitespace Makefile target to detect trailing whitespaces in source files - Add fix-trailing-whitespace Makefile target to automatically remove trailing whitespaces - Create CI workflow to check for trailing whitespaces on all pushes - Update CLAUDE.md with trailing whitespace removal requirements - Wrap Makefile target commands to 80 characters for better readability All file types covered: .rs, .toml, .md, .yaml, .yml, .json, .ts, .tsx, .js, .jsx with appropriate directory exclusions for build artifacts and dependencies.
- Create docs.yaml workflow for documentation CI/CD with: * Documentation build testing and broken link detection * Rust API documentation generation and integration * GitHub Pages deployment on develop branch * Versioned documentation creation on tag releases - Update Docusaurus config to include API documentation links - Add Makefile targets for Rust documentation integration
Applied automatic trailing whitespace removal across the codebase using the new fix-trailing-whitespace Makefile target. This ensures consistent formatting and prevents future trailing whitespace commits. Files affected: - Rust source files (.rs) - Configuration files (.toml, .yml, .yaml) - Documentation files (.md) - Frontend files (.js, .ts, .tsx) - Various other project files This is a formatting-only change with no functional modifications.
Convert all bare URLs to proper hyperlinks by wrapping them with angle brackets. This resolves the "this URL is not a hyperlink" warnings when running make docs-rust. Changes: - Wrapped all bare URLs in documentation comments with <> brackets - Fixed URLs in module-level docs (//\!), regular docs (///), and comments (//) - Processed all .rs files in the workspace excluding build artifacts All documentation URLs are now properly formatted as clickable hyperlinks in the generated API documentation.
- Add sqlite3 to build dependencies - Initialize SQLite database with heartbeats-processor schema - Set DATABASE_URL to file-based SQLite database for SQLx validation - Enables compile-time query checking for heartbeats-processor Fixes "set DATABASE_URL to use query macros online" errors in CI
dannywillems
force-pushed
the
dw/docs-docusaurus
branch
from
891add7 to
9f02aa0
Compare
0xMimir
reviewed
Jul 23, 2025
|
|
||
| - **Operating System**: Linux (Ubuntu 20.04+, Debian 10+) or macOS | ||
| - **Memory**: At least 8GB RAM (16GB recommended for block producers) | ||
| - **Storage**: 50GB+ free disk space |
There was a problem hiding this comment.
In website/docs/developers/getting-started.mdx it says 20GB
There was a problem hiding this comment.
20GB of storage is needed for building the node, but just for running I think free storage is irrelevant
|
For macOS: update the docs with the setup instructions and add it in CI (macos-latest). |
volhovm
approved these changes
Jul 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Partially solving https://github.com/o1-labs/openmina/issues/1233
Run
make docs-servelocally and enjoy.The work from @tizoc in https://github.com/o1-labs/openmina/pull/1173 will be integrated, totally or partially.