Skip to content

Commit

Permalink
Merge pull request #826 from swcurran/cleanupmkdocs
Browse files Browse the repository at this point in the history
Cleanup RFCs for mkdocs website generation
  • Loading branch information
WadeBarnes authored May 3, 2024
2 parents 393c46a + f0640a4 commit a013c9e
Show file tree
Hide file tree
Showing 81 changed files with 118 additions and 106 deletions.
6 changes: 3 additions & 3 deletions 0000-template-protocol.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0000: Your Protocol 0.9

- Authors: [your name](you@github-email) -- email is optional
- Authors: [your name](mailto:you@github-email) -- email is optional
- Status: [PROPOSED](/README.md#proposed)
- Since: 2019-12-26 (date you submit your PR)
- Status Note: (explanation of current status)
Expand Down Expand Up @@ -31,7 +31,7 @@ Specify the official name of the protocol and its version, e.g., "My Protocol 0.

Protocol names are often either lower_snake_case or kebob-case. The non-version components of the protocol named are matched exactly.

URI: https://didcomm.org/lets_do_lunch/<version>/<messageType>
URI: `https://didcomm.org/lets_do_lunch/<version>/<messageType>`

Message types and protocols are identified with special URIs that match certain conventions. See [Message Type and Protocol Identifier URIs](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0003-protocols/README.md#message-type-and-protocol-identifier-uris) for more details.

Expand Down Expand Up @@ -159,7 +159,7 @@ Adoption should be declared in an "Adopted" subsection of "Messages".
When adoption is specified, it should include a __minimum
adopted version__ of the adopted message type: "This protocol adopts
`ack` with version >= 1.4". All versions of the adopted message that share
the same major number should be compatible, given the [semver rules](concepts/0003-protocols/semver.md)
the same major number should be compatible, given the [semver rules](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0003-protocols/README.md#semver-rules-for-protocols)
that apply to protocols.

### Constraints
Expand Down
2 changes: 1 addition & 1 deletion 0000-template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Title (Ex. 0000: RFC Topic)
- Authors: [your name](you@github-email) -- email is optional
- Authors: [your name](mailto:you@github-email) -- email is optional
- Status: [PROPOSED](/README.md#proposed)
- Since: 2019-12-26 (date you submit your PR)
- Status Note: (explanation of current status)
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ If you are here to learn about Aries, we recommend you use the [the RFC Index](i

There are 2 types of Aries RFCs:

* RFCs that describe individual features (in the [features](./features) folder)
* RFCs that explain concepts underpinning many features (in the [concepts](./concepts) folder)
* RFCs that describe individual features (in the `./features` folder)
* RFCs that explain concepts underpinning many features (in the `./concepts` folder)

RFCs are for developers *building on* Aries. They don't provide guidance on how Aries components
implement features internally; individual Aries repos have design docs for that. Each
Expand Down Expand Up @@ -44,7 +44,7 @@ exploring.
__Demonstrated__ RFCs have one or more implementations available, listed in the "Implementations" section of the RFC document. As with the PROPOSED status, demonstrated RFCs haven't been endorsed by the community, but the ideas put forth have been more thoroughly explored through the implementation(s). The demonstrated status is an optional step in the lifecycle. For protocol-related RFCs, work on protocol tests SHOULD begin in the [test suite repo](https://github.com/hyperledger/aries-protocol-test-suite) by the time this status is assigned.

#### ACCEPTED
To get an RFC __accepted__, [build consensus](contributing.md#how-to-get-an-RFC-accepted) for your RFC on [chat](https://chat.hyperledger.org/channel/aries) and in community meetings. If your RFC is a feature that's protocol- or decorator-related, it MUST have reasonable tests in the [test suite repo](https://github.com/hyperledger/aries-protocol-test-suite), it MUST list the test suite in the protocol RFC's [Implementations section](../0000-template.md#implementations), at least one other implementation must have passed the relevant portions of the test suite, and all implementations listed in this section of the RFC MUST hyperlink to their test results. An accepted RFC is incubating on a standards track; the community has decided to polish it and is exploring or pursuing implementation.
To get an RFC __accepted__, [build consensus](contributing.md#how-to-get-an-RFC-accepted) for your RFC on [chat](https://chat.hyperledger.org/channel/aries) and in community meetings. If your RFC is a feature that's protocol- or decorator-related, it MUST have reasonable tests in the [test suite repo](https://github.com/hyperledger/aries-agent-test-harness), it MUST list the test suite in the protocol RFC's [Implementations section](/0000-template.md#implementations), at least one other implementation must have passed the relevant portions of the test suite, and all implementations listed in this section of the RFC MUST hyperlink to their test results. An accepted RFC is incubating on a standards track; the community has decided to polish it and is exploring or pursuing implementation.

#### ADOPTED
To get an RFC __adopted__, [socialize and implement](contributing.md#how-to-get-an-rfc-adopted). An RFC gets this status once it has significant momentum--when implementations accumulate, or when the mental model it advocates has begun to permeate our discourse. In other words, adoption is acknowledgment of a _de facto_ standard.
Expand Down
21 changes: 20 additions & 1 deletion code/genSite.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,30 @@ python code/aipUpdates.py -v 2.0 -l "./code/cpAIPs.sh" | \
source copy_aip.sh
rm copy_aip.sh

# Cleanup a few things in README, contributing and 0000-templates
for i in docs/contributing.md docs/README.md docs/0000*.md; do
sed \
-e 's#../../##g' \
-e 's#index.md#RFCindex.md#' \
-e 's#LICENSE)#LICENSE.md)#' \
$i >$i.tmp
mv $i.tmp $i
done


# Cleanup missing mailtos -- will always be needed for aip2 folder, but will be cleaned up in files
for i in docs/features/*/README.md docs/concepts/*/README.md docs/aip2/*/README.md; do
sed -e '/Authors/s#](#](mailto:#g' -e 's#mailto:mailto:#mailto:#g' $i >$i.tmp; mv $i.tmp $i
done

# Cleanup the links in the RFCs
for i in docs/features/*/README.md docs/concepts/*/README.md docs/aip2/*/README.md; do
sed \
-e 's#(/#(../../#g' \
-e 's#index.md#RFCindex.md#' \
-e 's#[\./]*\(concepts\)#../../\1#g' \
-e 's#[\./]*\(features\)#../../\1#g' \
-e 's#discover-../../#discover-#g' \
$i >$i.tmp
mv $i.tmp $i
done
Expand All @@ -50,7 +69,7 @@ for i in docs/aip2/*/README.md ; do head -n 1 $i | sed -e "s/# / - /" -e "s/:

# Navigation for all RFCs by Status
python code/generate_mkdocs_index.py
cat ${MKDOCSIDX} | sed "s# : concepts/0799#0799 Long Term Support: concepts/0799#" >>${MKDOCSTMP}
cat ${MKDOCSIDX} >>${MKDOCSTMP}
rm ${MKDOCSIDX}

mv ${MKDOCSTMP} ${MKDOCS}
2 changes: 1 addition & 1 deletion concepts/0003-protocols/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0003: Protocols

- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [ADOPTED](/README.md#adopted)
- Since: 2019-04-01
- Status Note: standards track and beginning to influence many mental models, but not yet [ADOPTED](/README.md#rfc-lifecycle).
Expand Down
2 changes: 1 addition & 1 deletion concepts/0004-agents/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0004: Agents

- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [ACCEPTED](/README.md#accepted)
- Since: 2019-01-15
- Status Note: On a standards track and beginning to influence many mental models, but not yet [ADOPTED](/README.md#rfc-lifecycle).
Expand Down
2 changes: 1 addition & 1 deletion concepts/0005-didcomm/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0005: DID Communication

- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [ADOPTED](/README.md#adopted)
- Since: 2019-11-21
- Status Note: Mature as concept, with multiple implementations.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0008-message-id-and-threading/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0008: Message ID and Threading

- Authors: [Daniel Bluhm]([email protected]), [Sam Curren]([email protected]), [Daniel Hardman]([email protected])
- Authors: [Daniel Bluhm](mailto:[email protected]), [Sam Curren](mailto:[email protected]), [Daniel Hardman](mailto:[email protected])
- Status: [ADOPTED](/README.md#adopted)
- Since: 2018-10-01
- Status Note: Implemented broadly in Indy, but not yet elsewhere.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0017-attachments/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0017: Attachments

- Authors: [Daniel Hardman]([email protected]), Sam Curren, Andrew Whitehead
- Authors: [Daniel Hardman](mailto:[email protected]), Sam Curren, Andrew Whitehead
- Status: [ADOPTED](/README.md#adopted)
- Since: 2024-05-01
- Status Note: Used in a number of other RFCs.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0021-didcomm-message-anatomy/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0021: DIDComm Message Anatomy

- Authors: [Tobias Looker]([email protected]), [Daniel Hardman]([email protected])
- Authors: [Tobias Looker](mailto:[email protected]), [Daniel Hardman](mailto:[email protected])
- Status: [ADOPTED](/README.md#adopted)
- Since: 2019-05-25
- Start Date: 2019-05-25
Expand Down
2 changes: 1 addition & 1 deletion concepts/0029-message-trust-contexts/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0029: Message Trust Contexts

- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [STALLED](/README.md#stalled)
- Since: 2024-04-03
- Status Note: Not practically applied.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0046-mediators-and-relays/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0046: Mediators and Relays

- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [ACCEPTED](/README.md#accepted)
- Since: 2019-02-01
- Status Note: Socialized and broadly understood in other conceptual RFCs about routing.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0047-json-ld-compatibility/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0047: JSON-LD Compatibility

- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [ACCEPTED](/README.md#accepted)
- Since: 2019-02-20
- Status Note: Has guided Indy design choices for several months. Not yet ratified by greater Aries community.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0049-repudiation/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0049: Repudiation

- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [ACCEPTED](/README.md#accepted)
- Since: 2019-03-01
- Status Note: Well understood and baked into various protocol designs and DIDComm processes--but not yet ratified by the larger Aries community.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0051-dkms/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0051: Decentralized Key Management

- Authors: [Drummond Reed]([email protected]) et al.
- Authors: [Drummond Reed](mailto:[email protected]) et al.
- Status: [RETIRED](/README.md#retired)
- Since: 2024-04-03
- Status Note: Covered elsewhere and not specific to Aries.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0094-cross-domain-messaging/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0094: Cross-Domain Messaging

- Authors: [Stephen Curran]([email protected])
- Authors: [Stephen Curran](mailto:[email protected])
- Status: [ADOPTED](/README.md#adopted)
- Since: 2024-05-01
- Status Note: Socialized and broadly understood in other conceptual RFCs about routing.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0207-credential-fraud-threat-model/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0207: Credential Fraud Threat Model
- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [STALLED](/README.md#stalled)
- Since: 2024-04-03
- Status Note: No implementations have been created. Socialized on an informal credential fraud study group (https://groups.google.com/d/forum/credential-fraud-study) circa 2019.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0217-linkable-message-paths/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Aries RFC 0217: Linkable Message Paths
- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [STALLED](/README.md#stalled)
- Since: 2024-04-03
- Status Note: No implementations have been created.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0231-biometric-service-provider/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0231: Biometric Service Provider

- Authors: [John Callahan]([email protected]), [Daniel Hardman]([email protected]), [Asem Othman]([email protected])
- Authors: [John Callahan](mailto:[email protected]), [Daniel Hardman](mailto:[email protected]), [Asem Othman](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2019-09-24
- Status Note: Proposed for now based on authors joint work
Expand Down
4 changes: 2 additions & 2 deletions concepts/0250-rich-schemas/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# RFC 0250: Rich Schema Objects
- Author: [Ken Ebert]([email protected]), [Brent Zundel]([email protected])
- Author: [Ken Ebert](mailto:[email protected]), [Brent Zundel](mailto:[email protected])
- Status: [STALLED](/README.md#stalled)
- Since: 2024-04-03
- Status Note: No recent progress and no implementations have been created.
Expand Down Expand Up @@ -341,7 +341,7 @@ Here is the paper that defines
[Camenisch-Lysyanskaya signatures.][CL-signatures] They are the source for
[Indy's AnonCreds protocol](https://github.com/hyperledger/indy-hipe/pull/109).

[CL-signatures]: (https://groups.csail.mit.edu/cis/pubs/lysyanskaya/cl02b.pdf)
[CL-signatures]: https://groups.csail.mit.edu/cis/pubs/lysyanskaya/cl02b.pdf

## Drawbacks

Expand Down
2 changes: 1 addition & 1 deletion concepts/0268-unified-didcomm-agent-deeplinking/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Aries RFC 0268: Unified DIDCOMM Deeplinking
- Authors: [Dev Bharel]([email protected]), [Alexi Falquier]([email protected])
- Authors: [Dev Bharel](mailto:[email protected]), [Alexi Falquier](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2019-10-23
- Status Note: Proposed
Expand Down
2 changes: 1 addition & 1 deletion concepts/0270-interop-test-suite/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0270: Interop Test Suite
- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2019-10-25
- Status Note: Codifies some thinking about scope and mental model that are already socialized. Provides some new thinking as well.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0289-toip-stack/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0289: The Trust Over IP Stack
- Authors: Matthew Davie, [Dan Gisolfi]([email protected]), [Daniel Hardman]([email protected]), [John Jordan]([email protected]), Darrell O'Donnell, [Drummond Reed]([email protected]), [Oskar van Deventer]([email protected])
- Authors: Matthew Davie, [Dan Gisolfi](mailto:[email protected]), [Daniel Hardman](mailto:[email protected]), [John Jordan](mailto:[email protected]), Darrell O'Donnell, [Drummond Reed](mailto:[email protected]), [Oskar van Deventer](mailto:[email protected])
- Status: [STALLED](/README.md#stalled)
- Since: 2024-04-03
- Status Note: No recent progress and no implementations have been created.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0345-community-coordinated-update/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0345: Community Coordinated Update
- Authors: [Sam Curren]([email protected])
- Authors: [Sam Curren](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2019-12-26 (date you submit your PR)
- Status Note: Initial Draft
Expand Down
2 changes: 1 addition & 1 deletion concepts/0346-didcomm-between-two-mobile-agents/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0346: DIDComm Between Two Mobile Agents Using Cloud Agent Mediator
- Author: [Sukalpo Mitra]([email protected])
- Author: [Sukalpo Mitra](mailto:[email protected])
- Start Date: 2019-06-23
- Tags: [concept](/tags.md#concept)
- Status: [PROPOSED](/README.md#proposed)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Aries RFC 0430: Machine-Readable Governance Frameworks
- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2020-02-24
- Status Note: early proposal only
Expand Down
2 changes: 1 addition & 1 deletion concepts/0440-kms-architectures/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0440: KMS Architectures
- Authors: [Michael Lodder]([email protected])
- Authors: [Michael Lodder](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2020-03-06
- Status Note: Proposed
Expand Down
2 changes: 1 addition & 1 deletion concepts/0441-present-proof-best-practices/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0441: Prover and Verifier Best Practices for Proof Presentation
- Authors: [Stephen Klump]([email protected])
- Authors: [Stephen Klump](mailto:[email protected])
- Status: [ADOPTED](/README.md#adopted)
- Since: 2024-05-01
- Status Note: Interoperability guidance when using AnonCreds Present Proof. An element of the AnonCreds subtarget for [AIP v2.0](../../concepts/0302-aries-interop-profile/README.md).
Expand Down
2 changes: 1 addition & 1 deletion concepts/0478-coprotocols/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Aries RFC 0478: Coprotocols
- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [STALLED](/README.md#stalled)
- Since: 2024-04-03
- Status Note: No recent progress and no implementations have been created.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0519-goal-codes/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0519: Goal Codes
- Authors: [Daniel Hardman]([email protected])
- Authors: [Daniel Hardman](mailto:[email protected])
- Status: [ACCEPTED](/README.md#accepted)
- Since: 2021-04-15
- Status Note: Used in several protocols that are part of [AIP 2.0](../0302-aries-interop-profile/README.md), such as the [Out-of-Band](../../features/0434-outofband/README.md) protocol.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0559-pppu/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Aries RFC 0559: Privacy-Preserving Proof of Uniqueness
- Authors: [Daniel Hardman]([email protected]), Drummond Reed, Lovesh Harchandani, Jason Law, Brent Zundel
- Authors: [Daniel Hardman](mailto:[email protected]), Drummond Reed, Lovesh Harchandani, Jason Law, Brent Zundel
- Status: [PROPOSED](/README.md#proposed)
- Since: 2020-10-21
- Status Note: documents ideas mentioned at RWOT 9 (Sep 2019) and in informal conversations before and since. This is a defensive publication by the Aries community, to prevent such ideas from being encumbered by patents.
Expand Down
2 changes: 1 addition & 1 deletion concepts/0566-issuer-hosted-custodidal-agents/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0566: Issuer-Hosted Custodial Agents
- Authors: [Sam Curren]([email protected])
- Authors: [Sam Curren](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2020-11-16
- Status Note: Draft
Expand Down
2 changes: 1 addition & 1 deletion concepts/0700-oob-through-redirect/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries RFC 0700: Out-of-Band through redirect

- Authors: [Sudesh Shetty]([email protected])
- Authors: [Sudesh Shetty](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2021-10-08
- Status Note: implementation is being explored by SecureKey
Expand Down
2 changes: 1 addition & 1 deletion concepts/0757-push-notification/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0757: Push Notification
- Authors: [Sam Curren]([email protected])
- Authors: [Sam Curren](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2022-11-02
- Status Note:
Expand Down
4 changes: 2 additions & 2 deletions concepts/0799-long-term-support/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 0799 Aries Long Term Support Releases
- Authors: [Sam Curren]([email protected])
# 0799: Aries Long Term Support Releases
- Authors: [Sam Curren](mailto:[email protected])
- Status: [PROPOSED](/README.md#proposed)
- Since: 2023-11-07
- Start Date: 2023-11-07
Expand Down
Loading

0 comments on commit a013c9e

Please sign in to comment.