Skip to content

Commit

Permalink
Improve homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
Ndpnt committed Dec 17, 2024
1 parent d4a00c9 commit e801103
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,25 @@ linkTitle: Homepage
weight: 1
---

# Open Terms Archive
# Open Terms Archive documentation

Open Terms Archive is a decentralised system that t
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.
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.

## Documentation structure
### Documentation structure

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

- **Tutorials:** Step-by-step learning guides to help the beginner get started with Open Terms Archive and acquire basic competence.
- **How to guides:** Practical, task-oriented guides that solve specific problems and help the already-competent user perform a particular task correctly.
- **Reference:** Technical documentation detailing Open Terms Archive's components, APIs, and specifications. This section provides comprehensive information for users who need precise technical details.
- **Tutorials:** Step-by-step learning guides that help beginners get started with Open Terms Archive, providing foundational knowledge and hands-on experience.
- **How-to guides:** Task-focused instructions that help experienced users accomplish specific goals efficiently and effectively.
- **Reference:** Comprehensive technical documentation detailing system components, configuration options, and specifications for advanced users.

## Contents
### Main contents

- [**Understanding**](/understanding/): Core concepts of Open Terms Archive
- [**Terms**](/terms/): How to track, analyze and monitor changes in terms of service
- [**Collections**](/collections/): Learn how to create and manage collections of tracked terms
- [**Programmatic access**](/programmatic-access/): Access terms programmatically through Collection APIs, Federation API, CLI tools, and Node.js modules
- [**Federation**](/federation/): How collections work together in a decentralized network
- [**Community**](/community/): Join our community on Mattermost and contribute to the project
- **[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.
- **[Community](/community/):** Provides information on how to join and participate in the Open Terms Archive community.
- **[Terms](/terms/):** Provides guidance on tracking and maintaining terms declarations, reference documentation for declaration formats, and guidelines for selecting selectors and reviewing contributions.
- **[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.
- **[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.
- **[Deployment](/deployment/):** Guides to deploy a collection.
- **[Programmatic access](/api/):** Provides documentation for programmatically interacting with Open Terms Archive.
- **[Concepts and principles](/concepts/):** Explains the main concepts and terminology of Open Terms Archive and fundamental design principles.

0 comments on commit e801103

Please sign in to comment.