Sasha
c498860135
Reviews the scaffold section against the five scaffold commits landed since it was written (#244, #245, #246, #247, #249) and against the canonical repository name. Corrections: - The repository is `logos-co/scaffold`; `logos-co/logos-scaffold` is a redirect. Restores the ecosystem table row and fixes the clone command and links, while keeping `logos-scaffold` for the crate and binary. - Basecamp's module-root override is now documented as the pair it is: 0.1.x reads LOGOS_DATA_DIR, 0.2.x reads LOGOS_USER_DIR, and `launch` sets both absolute per profile on macOS with a portable `[repos.basecamp].attr`. Adds the symptom that appears when only one is set: profiles collapsing onto the shared data tree. - The module socket is `logos_token_<module>` under TMPDIR, not XDG_RUNTIME_DIR, and the path cap applies on Linux too (108 bytes), so the guidance is no longer macOS-only. - Documents the full `launch` environment as a table. Additions: - `basecamp build --variant`, of which `build-portable` is now an alias, plus `develop`, `run`, `paths`, `docs`, and `launch --log-file`. - `.scaffold/basecamp/lgx/`, `.scaffold/wallet/`, and the development-only nature of the wallet key material. - The LEZ guide gains a `logos-scaffold run` section covering the six-step pipeline, run profiles, `topup`/`deploy` skips, the hook environment, and the no-inheritance rule for named profiles. It also exports LEE_WALLET_HOME_DIR next to NSSA_WALLET_HOME_DIR for LEZ v0.2.0, describes the wallet seeding change, and closes an unterminated code fence at the end of the page. - Cross-links between the LEZ guide, the module guide, and the core module tutorial so each entry point reaches the other. Sets the author on the scaffold pages to weboko.
Logos Documentation
Source repository for the Logos documentation site, built with Docusaurus.
Read the documentation at docs.logos.co.
If you are looking for an introduction to the Logos project itself, see the Logos website for an overview or the Get started section of the documentation for a deeper introduction.
Repository structure
Documents about a single component live in that component's doc set. The persona-based paths are curated views that link to documents in the component doc sets while also including path-specific documents. To follow the path that matches your role, visit docs.logos.co.
Content is never duplicated between paths and component doc sets: a document lives in exactly one place and is linked from wherever else it is needed.
docs/
├── get-started/ # Project introduction and orientation
├── run-an-app/ # ┐
├── run-a-node/ # ├ Persona paths: indexes linking into the
├── build-an-app/ # ├ component doc sets, plus path-specific guides
├── contribute/ # ┘
├── basecamp/ # ┐
├── blockchain/ # |
├── lez/ # |
├── core/ # ├ Component doc sets:
├── messaging/ # ├ documents about a single component
├── storage/ # |
├── mixnet/ # |
└── peer-discovery/ # ┘
The Logos ecosystem spans multiple GitHub organisations. If you are looking for a specific codebase rather than its documentation, see the repository orientation.
Contributing
Documentation is maintained by the Logos docs team. New documents, doc sets, and structural changes are planned and created by Logos core contributors.
External contributions are welcome in the following forms:
- Reviewing open pull requests. Comments on accuracy, clarity, and completeness help verify content before it is merged.
- Giving feedback on published content. If you find a typo, an error, or a passage that is unclear or outdated, open an issue in this repository.
All changes should be made through pull requests instead of direct commits to main.
See CONTRIBUTING.md for details.
Local development
Prerequisites: Node.js 20.0 or later.
git clone https://github.com/logos-co/logos-docs.git
cd logos-docs
npm install
npm start
npm start serves the site locally with hot reload at http://localhost:3000.
To create a production build:
npm run build