docs: Incorporate BigLep documentation comments from PR #16 #33
+210
−271
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -66,7 +66,7 @@ This will: | |||||
| - Start storage provider(s) | ||||||
| - Launch [Portainer UI](https://docs.docksal.io/use-cases/portainer/) for container management | ||||||
|
|
||||||
| **If you have troubles**: Use `cargo run -- start`, removing parallelism during start, this may take longer. | ||||||
|
|
||||||
| **That's it!** Your local Filecoin network is running. | ||||||
|
|
||||||
|
|
@@ -109,7 +109,7 @@ From building Docker images to deploying contracts—everything is automated: | |||||
| Built with modular steps for easy extension and customization: | ||||||
| - Add custom deployment steps | ||||||
| - Configure multiple PDP service providers | ||||||
| - Control "allowed" SP nodes via `~/.foc-devnet/config.toml` (see [Configuration System](README_ADVANCED.md#configuration-system)) | ||||||
|
|
||||||
| ### 📜 Programmable | ||||||
| Built for scripting and automation: | ||||||
|
|
@@ -139,12 +139,13 @@ Bundled with Portainer for browser-based Docker management—no terminal wizardr | |||||
| | **Docker** | Desktop (macOS) or CE (Linux) | | ||||||
| | **tar** | Archive utility (usually pre-installed) | | ||||||
| | **Disk Space** | ~20GB for images and blockchain data | | ||||||
| | **x86 Architecture** | Some dependencies require x86 (Intel) architecture. As a result, ARM-based architectures (including Apple Silicon) may not be supported. See [GitHub Issues](https://github.com/FilOzone/foc-devnet/issues) for current architecture compatibility status. | | ||||||
|
Contributor
Author
There was a problem hiding this comment.
Suggested change
@redpanda-f: can you add a note about why ARM isnt' supported? I thought you said it was because Curio doesn't support it, but I see it does: https://docs.curiostorage.org/installation#arm-based-cpus If we don't know why it doesn't support it, can you please create a backlog item and we add iink to that backlog item here? |
||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## 🛠️ Need More? | ||||||
|
|
||||||
| See **[README_ADVANCED.md](README_ADVANCED.md)** for comprehensive documentation on: | ||||||
| - **All commands reference** (init, build, start, stop, status, version) | ||||||
| - **Configuration system** (config.toml structure, parameters, editing) | ||||||
| - **Complete directory structure** (what's stored where and why) | ||||||
|
|
@@ -156,7 +157,7 @@ See **[ADVANCED_README.md](ADVANCED_README.md)** for comprehensive documentation | |||||
| - **Lifecycle overview** (full startup sequence, step implementation) | ||||||
| - **Service Provider examples** (1 SP with 0 authorized, 3 SPs with top 2 authorized, etc.) | ||||||
| - **Troubleshooting guides** (port conflicts, build failures, network issues) | ||||||
| - **Additional user actions** (custom genesis, Lotus API access, contract interaction) | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
|
|
||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The architecture requirement statement is unclear about whether ARM-based architectures are definitively unsupported or potentially unsupported. Consider clarifying by stating either 'are not supported' if this is confirmed, or 'may experience issues' if support status varies by dependency. Also consider adding a brief note about workarounds (e.g., Rosetta 2, Docker x86 emulation) if any exist.