You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/_index.md
+16-15Lines changed: 16 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,24 +4,25 @@ linkTitle: Homepage
4
4
weight: 1
5
5
---
6
6
7
-
# Open Terms Archive
7
+
# Open Terms Archive documentation
8
8
9
-
Open Terms Archive is a decentralised system that t
10
-
racks 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.
9
+
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.
11
10
12
-
## Documentation structure
11
+
###Documentation structure
13
12
14
-
In this documentation you can find this kind of content:
13
+
In this documentation you can find the following kind of content to support users at different levels:
15
14
16
-
-**Tutorials:** Step-by-step learning guides to help the beginner get started with Open Terms Archive and acquire basic competence.
17
-
-**Howto guides:**Practical, task-oriented guides that solve specific problems and help the already-competent user perform a particular task correctly.
18
-
-**Reference:**Technical documentation detailing Open Terms Archive's components, APIs, and specifications. This section provides comprehensive information for users who need precise technical details.
15
+
-**Tutorials:** Step-by-step learning guides that help beginners get started with Open Terms Archive, providing foundational knowledge and hands-on experience.
16
+
-**How-to guides:**Task-focused instructions that help experienced users accomplish specific goals efficiently and effectively.
17
+
-**Reference:**Comprehensive technical documentation detailing system components, configuration options, and specificationsfor advanced users.
19
18
20
-
##Contents
19
+
### Main contents
21
20
22
-
-[**Understanding**](/understanding/): Core concepts of Open Terms Archive
23
-
-[**Terms**](/terms/): How to track, analyze and monitor changes in terms of service
24
-
-[**Collections**](/collections/): Learn how to create and manage collections of tracked terms
25
-
-[**Programmatic access**](/programmatic-access/): Access terms programmatically through Collection APIs, Federation API, CLI tools, and Node.js modules
26
-
-[**Federation**](/federation/): How collections work together in a decentralized network
27
-
-[**Community**](/community/): Join our community on Mattermost and contribute to the project
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.
0 commit comments