Below are few areas where we can improve compass documentation (especially on compass gitbook):

1. Documentation sections structure.
2. Improving user's journey. (e.g. have a quick start section with super minimal guide to get user started with basic features).
3. Some other improvements.

1. Documentation sections structure

Proposed changes on structure

General
1. Introduction
2. Roadmap
4. Changelog

Get Started
1. Installation
   a. Setup Dependencies (Postgres & Elasticsearch)
   b. Building binary
   c. Setup minimum configuration (compass.yaml)
   d. Running migration
   e. Running service
2. Ingesting Metadata
3. Querying Metadata

Guides
1. Lineage
2. Starring/Bookmarking an asset
3. Discussion feature
4. Asset Tagging
5. Asset Versioning

Concept
1. Asset
   a. Type
2. User (identity header explanation)
3. Architecture
4. Internals

...rest is similar

2. Improving user's journey

One way we can improve our user's journey is by having a quick start (get started) section with super minimal guide to get user started with our basic features.

The goal of having simple basic guides is to make sure user's journey when reading the docs does not seem too overwhelming which may hinder users to start.

Then we can have the rest of compass' features (Star, Lineage, etc) to another section (e.g. Guides or Advanced Guides).

3. Some other improvements

Installation:

• Add setting up configuration section

Ingesting Metadata:

• api docs link is broken
• Use real world sample .e.g (instead of using picollo as an example service, we can use bigquery or postgres to make it more relatable.