Skip to content

Commit

Permalink
Housekeeping (#47)
Browse files Browse the repository at this point in the history
Cleaning up leftover changes that were missed by previous PRs
  • Loading branch information
ahouseholder authored Jan 4, 2024
1 parent f99ff0a commit 06dabb3
Show file tree
Hide file tree
Showing 10 changed files with 44 additions and 370 deletions.
7 changes: 0 additions & 7 deletions docs/adr/README.md

This file was deleted.

80 changes: 0 additions & 80 deletions docs/adr/adr-template.md

This file was deleted.

46 changes: 35 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,37 +23,61 @@ The Vultron Protocol is a collection of ideas, models, code, and work in progres

## How this documentation is organized

!!! tip inline "Learning About Vultron"
We are in the process of documenting the Vultron CVD Protocol as we work towards a prototype implementation.
We are using the [Diátaxis Framework](https://diataxis.fr/) to organize our documentation into four main categories,
oriented around the different ways that people might need to learn about and use the Vultron Protocol.

Our current focus is on the [Understanding Vultron](topics/background/index.md) section, which describes the protocol
in detail.

The [Learning Vultron](tutorials/index.md) section is intended to eventually include tutorials and other
<div class="grid cards" markdown>

- :material-school:{ .lg .middle } **Learning About Vultron**

---

The [Learning Vultron](tutorials/index.md) section is intended to eventually include tutorials and other
information about the Vultron Protocol that is oriented towards novice users and getting started with the protocol.
However, because we are still in the early stages of the project, this section is just a placeholder for now.

!!! abstract inline end "Understanding Vultron"
[:octicons-arrow-right-24: Learning Vultron](tutorials/index.md)

- :fontawesome-solid-book-open:{ .lg .middle } **Understanding Vultron**

---

The [Understanding Vultron](topics/background/index.md) section includes background information about Vultron,
including the motivation for the project, the problem space that we are trying to address, and the design principles
that we are using to guide our work. It also includes a detailed description of the Vultron Protocol, including
the state machines and behavior logic that we use to model the behavior of the protocol.

!!! question inline "Implementing Vultron"
Focus on your content and generate a responsive and searchable static site

[:octicons-arrow-right-24: Understanding Vultron](topics/background/index.md)

- :fontawesome-solid-code:{ .lg .middle } **Implementing Vultron**

---

The [Implementing Vultron](howto/index.md) section includes guidance for potential implementations of Vultron.
In the future, we plan to include how-to guides to help you use Vultron, but for now it is focused on guidance for
potential implementers of Vultron.

!!! info inline end "Vultron Protocol Reference"
Change the colors, fonts, language, icons, logo and more with a few lines

[:octicons-arrow-right-24: Implementing Vultron](howto/index.md)

- :material-bookshelf:{ .lg .middle } **Reference**

---

The [Reference](reference/index.md) section includes the formal Vultron Protocol specification, crosswalks the
The [Reference](reference/index.md) section includes the formal Vultron Protocol specification, crosswalks the
protocol with other related standards and protocols, etc.
In the future, we plan to include other reference information about Vultron, including code documentation.

We are in the process of documenting the Vultron CVD Protocol as we work towards a prototype implementation.
We are using the [Diátaxis Framework](https://diataxis.fr/) to organize our documentation into four main categories,
oriented around the different ways that people might need to learn about and use the Vultron Protocol.
[:octicons-arrow-right-24: Reference](reference/index.md)

Our current focus is on the [Understanding Vultron](topics/background/index.md) section, which describes the protocol
in detail.
</div>

## Background

Expand Down
197 changes: 0 additions & 197 deletions docs/reference/glossary.md

This file was deleted.

8 changes: 8 additions & 0 deletions docs/reference/ontology/rfc2119.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ the `ontology` directory.

&nbsp;

&nbsp;

&nbsp;

&nbsp;

&nbsp;

=== "Markdown Documentation"

{% include-markdown "../../includes/ontology_tips.md" %}
Expand Down
11 changes: 0 additions & 11 deletions docs/topics/process_models/dfa_notation_definition.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/topics/process_models/em/embargo_defn.md

This file was deleted.

Loading

0 comments on commit 06dabb3

Please sign in to comment.