Skip to content

Commit 563b5ab

Browse files
updated index
1 parent 3a3f2f6 commit 563b5ab

2 files changed

Lines changed: 17 additions & 5 deletions

File tree

docs/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
11
# Welcome to the BREADS Docs!
22

33
This is the documentation for the _Broadly Expandable and Reconfigurable Data Acquisition and Automation Device Specification_ (BREADS). Check out [feastorg.github.io/BREADS](https://feastorg.github.io/BREADS/) where these docs are hosted for easy access.
4+
5+
## What is BREADS?
6+
7+
- Specifies mechanical form factor and connector pinout
8+
- Defines power distribution and signal bus conventions
9+
- Supports scalable, stackable, and distributed systems
10+
11+
## Planned implementations
12+
13+
- SLICE function cards
14+
- Single-function Logic Interface Controller Element
15+
- CRUST interface bridges
16+
- Configurable Routing & Universal Signal Translator
17+
- LOAF backplanes
18+
- Local Operations Attachment Frame

docs/_config.yml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,9 @@ kramdown:
1515

1616
# Don't publish these
1717
exclude:
18-
- .github
19-
- Gemfile*
20-
- node_modules
21-
- vendor
22-
- breads_planning.drawio
2318
- TODO.md
19+
- .indexignore
20+
- breads_planning.drawio
2421

2522
# Apply layout: page to all markdown under docs/
2623
defaults:

0 commit comments

Comments
 (0)