Skip to content

Goals and Structure for V2 Docs

Let's make some new docs! This is the current

Goals

  1. Explain the high level goals of the fathom project in clear and impactful language
  2. Explain the specifics of our technology (the protocol) and how that relates to the goals
  3. Explore the implications of the protocol in the short, medium, and long term.
  4. Document specific decisions or nuances, i.e formulas, attack mitigations, or implementations

Structure

We want to structure the documentation to make it as easy as possible for readers to find the information they need. Instead of a linear reading structure, each page should stand on it's own and clearly define it's:

  • audience
  • content
  • prerequisties (i.e technical knowledge).

However this could lead to specific pages being hard to find or information being scattered, so we should put effort into good index pages and "More information" type links at the end of each page.

Technical requirements

To start with we don't have any particular technical constraints, but we do want the docs to be as easy to contribute to and edit as possible.

In the future we may want to build more complicated interactive elements like simulations, or have rich elements like folding sections or sidenotes.

Next Steps

We need to come to consensus on a structure and then begin creating a list of the information the docs need to contain. From there we can break them up into chunks of work that can be tackled in parallel.

@djudjuu I'd specifically like your thoughts on the structure piece, and whether or not you think index pages + more information links, are enough to make up for the lack of a linear structure.