Scoped markdown-lint workflow to PR-changed Markdown targets. Adds target handling so metadata/generated-output validation runs against changed docs, while markdownlint/remark continue linting only non-raw changed Markdown files. This PR was made with help from Codex
Logos LIP (Logos Improvement Proposals) Index
NOTE: This repo is still evolving while the LIP process is refined.
This repository contains specifications from the Messaging, Blockchain, Storage, and AnonComms components of the IFT portfolio. LIPs are Requests for Comments that document protocols, processes, and system interfaces in a consistent, reviewable format.
LIP process
This repository replaces the old rfc.vac.dev resource. Specs are maintained in Markdown here and progress through statuses such as raw, draft, stable, or deprecated. The process and lifecycle are defined in:
- 1/COSS:
docs/research/draft/1/coss.md
Contributing
- Open a pull request against this repo.
- Add or update the LIP in the appropriate component folder.
- Include status and category metadata in the header table.
If you are unsure where a document belongs, open an issue first and we will help route it.
Component indexes
- Messaging:
docs/messaging/README.md - Blockchain:
docs/blockchain/README.md - Storage:
docs/storage/README.md - AnonComms:
docs/anoncomms/README.md - Research:
docs/research/README.md
Local setup
- Install mdBook (pick the version that matches your Rust toolchain).
- Install Python dependencies if needed.
To install mdBook via Make:
make install
Build and serve
Run the generators before building or serving:
python scripts/run_runtime_generators.py
mdbook build
To serve locally:
make serve
Or run the commands directly:
python scripts/run_runtime_generators.py
mdbook serve -p 3000 -n 0.0.0.0
CI/CD
- CI builds
masterand pushes todeploy-masterbranch, which is hosted at https://lip.logos.co/. - CI builds
developand pushes todeploy-developbranch, which is hosted at https://dev-lip.logos.co.dev/.
The hosting is done using Caddy server with Git plugin for handling GitHub webhooks.
Information about deployed build can be also found in /build.json available on the website.