# Website Documentation Structure

## User Taxonomy

1. General Users - GU: Complete novices have no idea about the system [funders/advertisers/students]
- **Requirements**: Flowery, easy-to-understand language. Just requires getting things done with lowest possible de-bugging.

2. Experimenters - EU: People who have tech knowledge and want to try the system but have almost no idea about Oakestra [thesis students/demonstrators]
- **Requirements**: Can be somewhat technical. Only have important information. But have links to more detailed pages if they are interested. Highlight those links with info banners

3. Devs - DU: People who have tech ideas and are also knowledgeable about the system [Oakestra devs, maintainers]
- **Requirements**: Be super technical. Think API references. Doesnt even need a lot of text but clearly formatted information.

4. Contributors - CU: People who want to change the system and do updates
- **Requirements**: Be clear. Dictate information. Be stern even on requirements. Follow common structure.

## Directory Structure

|--- Get Started [GU] !@Matthew - done
|--- First Oakestra Cluster
|--- Deploy your App
|--- API way (default writeup)
|--- Dashboard way (dashboard-features walkthrough)
|--- CLI way (TBA - @Alex)
|--- Concepts [EU] !@Matthew
|--- High level Architecture
|--- Orchestration {empty -- TBA}
|--- Task scheduling
|--- Networking {TBA - @Giovanni and @Simon}
|--- Addons {TBA - and }
|--- "what are addons"
|--- "how to use addons"
|--- "overview/list of available addons with links to their dedicated links in the Manuals (?)"
|--- FLOps {TBA - }
|--- "what is FLOps"
|--- "how to use"
|--- "link to further details - manuals"
|--- "how to develop addons -> Link to Manuals"
|--- Features {Add graphs here}
|--- Performance
|--- Heterogeneity
|--- {TBA}
|--- Manuals {Internals} [DU]
|--- Unikernel Operations {TBA - @Giovanni + @Patrick}
|--- Kubernetes integration {TBA - @Jakob}
|--- Networking internals
|--- Semantic addressing
|--- IPv4 addressing
|--- IPv6 addressing {TBA - clean writeup}
|--- Gateway operations {TBA - clean writeup}
|--- Dashboard Features
|--- Organization
|--- Email configuration
|--- {TBA}
|--- CLI {TBA }
|--- Motivation & Vision
|--- APIs and details of command tree
|--- "Development Guide"
|--- "Discussion of chosen Fragework Typer vs alternatives, etc."
|--- Future-Work
|--- Debugging
|--- Networking
|--- Control plane
|--- Unikernels
|--- Addons {TBA - @melkodary and @malyuka}
|--- Addons in general (workflow - components, etc.)
|--- Available Addons
|--- FLOps {TBA -
|--- Details (What/components) - for now from the thesis (but necessary to be able to update (thesis is static))
|--- "Thinks to keep in mind when developing - tipps & tricks"
|--- "Future Work (ideas, challenges, etc.)"

|--- Contribution Guide [CU] !@Nitinder
|--- Git hook guide
|--- Language guide {Python + TBA - @Luca}
|--- Code of Conduct