Skip to content

Commit 54d4b75

Browse files
committed
Improve homepage
1 parent 0563920 commit 54d4b75

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

content/_index.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,32 @@ weight: 1
88

99
Open Terms Archive is a decentralised system that tracks collections of services' terms across multiple servers. Each collection operates its own API, and the Federation API unifies search and discovery across collections, fostering collaboration with external applications.
1010

11-
### Documentation structure
11+
## Required minimal terminology
12+
13+
Before diving into the details, let's first understand the essential terminology used throughout this documentation.
14+
15+
- **Service**: An entity that provide a service to users.
16+
- **Terms**: The contractual or non-contractual documents published by services (such as Terms of Service, Privacy Policy, Community Guidelines) that users agree to.
17+
- **Collection**: A set of tracked terms defined by a specific scope (such aslanguage, jurisdiction, industry, …).
18+
- **Declaration**: A JSON file that defines which terms to track for a service and how to track them.
19+
- **Snapshot**: The original document (HTML, PDF, …) where the terms will be extracted.
20+
- **Version**: The actual terms from a snapshot after removing irrelevant elements and noise.
21+
22+
## Documentation structure
1223

1324
In this documentation you can find the following kind of content to support users at different levels:
1425

1526
- **Tutorials:** Step-by-step learning guides that help beginners get started with Open Terms Archive, providing foundational knowledge and hands-on experience.
1627
- **How-to guides:** Task-focused instructions that help experienced users accomplish specific goals efficiently and effectively.
1728
- **Reference:** Comprehensive technical documentation detailing system components, configuration options, and specifications for advanced users.
1829

19-
### Main contents
30+
## Main contents
2031

21-
- **[Analysis](/analysis/):** Provides guidance on how to analyze terms changes, from navigating through the history of tracked documents to publishing memos about significant changes, along with copywriting guidelines for creating analysis content.
22-
- **[Community](/community/):** Provides information on how to join and participate in the Open Terms Archive community.
23-
- **[Terms](/terms/):** Provides guidance on tracking and maintaining terms declarations, reference documentation for declaration formats, and guidelines for selecting selectors and reviewing contributions.
24-
- **[Collections](/collections/):** Provides guidance on creating and managing collections of tracked terms, creating repositories and defining metadata, and detailed reference documentation for configuration options, environment variables, governance roles, and collection metadata formats.
25-
- **[Federation](/federation/):** Explains the benefits of joining the Open Terms Archive federation, and the criteria that collections must meet to be part of the federated ecosystem.
26-
- **[Deployment](/deployment/):** Guides to deploy a collection.
27-
- **[Programmatic access](/api/):** Provides documentation for programmatically interacting with Open Terms Archive.
28-
- **[Concepts and principles](/concepts/):** Explains the main concepts and terminology of Open Terms Archive and fundamental design principles.
32+
- **Analysis:** Provides guidance on how to analyze terms changes, from navigating through the history of tracked documents to publishing memos about significant changes, along with copywriting guidelines for creating analysis content.
33+
- **Community:** Provides information on how to join and participate in the Open Terms Archive community.
34+
- **Terms:** Provides guidance on tracking and maintaining terms declarations, reference documentation for declaration formats, and guidelines for selecting selectors and reviewing contributions.
35+
- **Collections:** Provides guidance on creating and managing collections of tracked terms, creating repositories and defining metadata, and detailed reference documentation for configuration options, environment variables, governance roles, and collection metadata formats.
36+
- **Federation:** Explains the benefits of joining the Open Terms Archive federation, and the criteria that collections must meet to be part of the federated ecosystem.
37+
- **Deployment:** Guides to deploy a collection.
38+
- **Programmatic access:** Provides documentation for programmatically interacting with Open Terms Archive.
39+
- **Concepts and principles:** Explains the main concepts and terminology of Open Terms Archive and fundamental design principles.

0 commit comments

Comments
 (0)