Skip to content
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.

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

docs: refactor docs/spec to use mdbook #1161

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/spec/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book
11 changes: 11 additions & 0 deletions docs/spec/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# EigenDA Spec

Built using [mdBook](https://rust-lang.github.io/mdBook/index.html).

Meant to contain technical overviews, spec, and low-level implementation details related to EigenDA, as opposed to the [docs](https://docs.eigenda.xyz/) site which is meant to contain more introductory and high-level material.

## Images

`./src/assets` is a symlink to `docs/assets` in order for MdBook to be able to access the images and other assets in the `docs` directory, given that it seems to only have access to the `src` directory.

Still not quite sure what's the best directory structure. Perhaps we could simply move the assets directory entirely under book/src, but then other READMEs throughout the repo that need access to those assets would need to be updated.
9 changes: 9 additions & 0 deletions docs/spec/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[book]
authors = ["Samuel Laferriere"]
language = "en"
multilingual = false
src = "src"
title = "EigenDA Spec"

[output.html]
mathjax-support = true
127 changes: 0 additions & 127 deletions docs/spec/old/assignment.md

This file was deleted.

Loading
Loading