Skip to content

Refactor documentation structure and address review feedback #18

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

Closed
Copilot wants to merge 3 commits into from
Closed

Refactor documentation structure and address review feedback #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c13ef70
Initial plan
Copilot Jan 7, 2026
a8e8a44
Rename Advanced_Readme.md to README_ADVANCED.md and address documenta…
Copilot Jan 7, 2026
a1ff119
Fix code review findings: clarify ISO8601 format, remove timing incon…
Copilot Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,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-localnet/config.toml`
- Control "allowed" SP nodes via [`~/.foc-localnet/config.toml`](README_ADVANCED.md#configuration-system)

### 📜 Programmable
Built for scripting and automation:
Expand Down Expand Up @@ -132,11 +132,13 @@ Bundled with Portainer for browser-based Docker management—no terminal wizardr
| **tar** | Archive utility (usually pre-installed) |
| **Disk Space** | ~20GB for images and blockchain data |

**⚠️ Important:** Currently, only **x86_64 architecture** is supported. Apple Silicon (M1/M2/M3) Macs are not yet supported. We're tracking ARM64 support in our backlog.

---

## 🛠️ Need More?

See **[Advanced_Readme.md](Advanced_Readme.md)** for comprehensive documentation on:
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)
Expand Down
Loading