From b85a4ab2bfb3bbb124052d6f09ffbd864fc8402c Mon Sep 17 00:00:00 2001 From: Varun Srinivasan Date: Sun, 3 Sep 2023 22:19:38 -0700 Subject: [PATCH] docs: fix duplication with docs.farcaster.xyz (#113) --- README.md | 18 +++++++++--------- docs/GOVERNANCE.md | 26 -------------------------- docs/PROPOSALS.md | 40 ---------------------------------------- 3 files changed, 9 insertions(+), 75 deletions(-) delete mode 100644 docs/GOVERNANCE.md delete mode 100644 docs/PROPOSALS.md diff --git a/README.md b/README.md index b4b1392..6394a11 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,22 @@ ![Archway](/images/arch512.png) -Farcaster is a protocol for decentralized social applications. - ## Getting Started -1. Start using Farcaster with one of many [Farcaster Apps](https://www.farcaster.xyz/apps). -2. Learn how Farcaster works by watching the [protocol overview series](https://www.farcaster.xyz/protocol). -3. Create your own apps by following tutorials in the [developer portal](https://www.farcaster.xyz/devs). +Farcaster is a protocol for building decentralized social apps. This repository contains the technical specification for implementing Farcaster. + +If you are instead looking for: + +1. How to get started, check out [farcaster.xyz](https://www.farcaster.xyz). +2. Developer documentation, check out [docs.farcaster.xyz](https://docs.farcaster.xyz). ## Specifications -This repository lays out the technical specification for implementing Farcaster. It is divided into four sections: +The specification is maintained as a Markdown file. There are three important sections: 1. [Overview](/hub/README.md) - A high level overview of the protocol. -2. [Proposals](/hub/README.md) - A list of proposals to improve the protocol. -3. [Hub Specification](/hub/README.md) - The technical specification for implementing a Farcaster Hub. -4. [Governance](/hub/README.md) - An overview of how the protocol is governed. +2. [Specification](/hub/README.md) - The technical spec for implementing Farcaster. +3. [FIP Discussions](https://github.com/farcasterxyz/protocol/discussionsd) - A forum where new proposals to change the specification are discussed. ## Contributing diff --git a/docs/GOVERNANCE.md b/docs/GOVERNANCE.md deleted file mode 100644 index 23c30ef..0000000 --- a/docs/GOVERNANCE.md +++ /dev/null @@ -1,26 +0,0 @@ -# Governance - -Farcaster is designed to be a long-lived, upgradeable protocol. - -Our approach to governance is to begin with simple, lightweight processes to optimize for speed and community participation. As the protocol matures and moved to mainnet status, we will add more structure to ensure that the protocol remains credibly decentralized. - -## Proposing Changes - -New changes can be proposed by opening up a new discussion topic in the [protocol](https://github.com/farcasterxyz/protocol/discussions), hub or contract repositories. The community can comment and make suggestions and the core team will make the final decision on accepting changes. Major changes will also be discussed on the [bi-weekly developer calls](https://calendar.google.com/calendar/u/0?cid=NjA5ZWM4Y2IwMmZiMWM2ZDYyMTkzNWM1YWNkZTRlNWExN2YxOWQ2NDU3NTA3MjQwMTk3YmJlZGFjYTQ3MjZlOEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t). The core team controls access to the Github repositories and accepts changes. Once approved, an issue is created and the specification changes are merged into this repository. - -The Farcaster core team will work closely with Hub operators and application developers to ensure that changes land smoothly with minimal disruption to the network. Hub operators also have a veto over changes to the Hub, which they can exercise by not upgrading their version of the Hub. It is desirable for developers and operators to have this power to ensure decentralization of the network, but ideally they would never need to exercise it. - -## Fname Usage Policy - -Fnames are off-chain ENS names issued by the Farcaster protocol to users. They are free to register and governed by a simple policy that prevents squatting and impersonation. The policy is manually enforced for now since it is not easy to automate and has two tenets: - -1. If you register an fname connected to a well-known public person or entity, your name may be deregistered. (e.g. `@google`) -2. If don't actively use an fname for 60+ days, your name may be de-registered at our discretion. - -Human intervention is often needed to resolve reasonable conflicts. For instance, you register `@elon` and Elon Musk signs up after you and wants the name. In such a case, we would ask three questions that guide the decision: - -- Is the user active on Farcaster? (e.g. they've made several high quality posts in the last 60 days) -- Does the user have a reasonable claim to the name? (e.g. their name also Elon?) -- Does the user hold similar, active handles on other networks? (e.g. they own elon on twitter and elon.ens) - -Users who wish to use a fully decentralized namespace can use on-chain ENS names, which are fully supported by the protocol. diff --git a/docs/PROPOSALS.md b/docs/PROPOSALS.md deleted file mode 100644 index b7e37f2..0000000 --- a/docs/PROPOSALS.md +++ /dev/null @@ -1,40 +0,0 @@ -# Farcaster Proposals - -Many design choices have nuances and tradeoffs that are difficult to express tersely in the protocol docs. Long form proposal documents are usually produced to discuss these decisions which cover such details. This section includes links to such proposals whose design decisions are relevant to the current protocol state. - -#### May 2023 - -- [FIP-4: ENS Usernames](https://github.com/farcasterxyz/protocol/discussions/90) - -#### April 2023 - -- [A Turing Complete Social Protocol](https://hackmd.io/3uAhr3bgRIOSlV8Nfv5mYA) -- [Farcaster Wallets](https://hackmd.io/ObCWFizyQrivDp4cnzxlow) -- [FIP-1: Canonical URIs](https://github.com/farcasterxyz/protocol/discussions/72) -- [FIP-2: Arbitrary Targets](https://github.com/farcasterxyz/protocol/discussions/71) -- [FIP-3: Links](https://github.com/farcasterxyz/protocol/discussions/85) - -#### March 2023 - -- [String Lengths: Bytes or Characters? ](https://hackmd.io/dC1ou7fZTkiUyPTTxlFLOQ) - -#### January 2023 - -- [Making Casts More Flexible](https://hackmd.io/@farcasterxyz/SypxvxUjs) -- [Handling Storage, Bandwidth and Eclipse Attacks](https://hackmd.io/@farcasterxyz/HkPnA_iss) - -#### December 2022 - -- [Decentralizing the Social Graph](https://hackmd.io/IP-8snyMQfOGxV3LUjlJbA) -- [Smart Contract Wallets for Farcaster](https://hackmd.io/1OpipDgCRaOdXKXQYjVuzQ) - -#### November 2022 - -- [Collision Attacks on Message Identifiers](https://hackmd.io/z_WWPg_4RQO8irbZepjQUA) -- [Handling Custody Transfers Safely](https://hackmd.io/NdBdxUaCTWCbNZ7yUWStnA) - -#### October 2022 - -- [Decentralization of Hubs](https://hackmd.io/@farcasterxyz/ry0QL4M4o) -- [Pruned Sets](https://hackmd.io/fCa8_RCEQ4qBYZjfnas9Zg) -- [Farcaster Message Identifiers](https://hackmd.io/J82kyDFvT56umneqvX4IPA)