diff --git a/README.md b/README.md index c4a6f4e..15b60aa 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ These modules are not necessarily meant to be deployed on the same device or wri ## API -The API of each module is specified via [Readium Evolution Proposals](https://readium.org/architecture/proposals/), which are discussed collaborativelty before being implemented by the core developers of the toolkits. +The API of each module is specified in the [Readium Specifications](specs), which are discussed collaboratively before being implemented by the core developers of the toolkits. ## Ecosystem diff --git a/proposals/000-template.md b/specs/000-template.md similarity index 100% rename from proposals/000-template.md rename to specs/000-template.md diff --git a/proposals/001-media-type.md b/specs/001-media-type.md similarity index 100% rename from proposals/001-media-type.md rename to specs/001-media-type.md diff --git a/proposals/002-composite-fetcher-api.md b/specs/002-composite-fetcher-api.md similarity index 100% rename from proposals/002-composite-fetcher-api.md rename to specs/002-composite-fetcher-api.md diff --git a/proposals/003-publication-encapsulation.md b/specs/003-publication-encapsulation.md similarity index 100% rename from proposals/003-publication-encapsulation.md rename to specs/003-publication-encapsulation.md diff --git a/proposals/004-publication-helpers-services.md b/specs/004-publication-helpers-services.md similarity index 100% rename from proposals/004-publication-helpers-services.md rename to specs/004-publication-helpers-services.md diff --git a/proposals/005-streamer-api.md b/specs/005-streamer-api.md similarity index 98% rename from proposals/005-streamer-api.md rename to specs/005-streamer-api.md index ae800e4..a894429 100644 --- a/proposals/005-streamer-api.md +++ b/specs/005-streamer-api.md @@ -52,7 +52,7 @@ While Readium ships with sane default parser settings, some degree of configurat The Streamer is one of the main components of the Readium Architecture, whose responsibilities are to: * parse packaged or exploded publications into a Readium `Publication` model -* [compose the `Fetcher` tree](https://github.com/readium/architecture/blob/master/proposals/002-composite-fetcher-api.md#developer-guide) providing access to publication resources +* [compose the `Fetcher` tree](https://github.com/readium/architecture/blob/master/specs/002-composite-fetcher-api.md#developer-guide) providing access to publication resources * unlock content protection technologies ### Usage @@ -144,7 +144,7 @@ If you just want to add HTTP headers or set up caching and networking policies f The Readium Architecture is opened to support additional publication formats. -1. [Register your new format and add a sniffer](https://readium.org/architecture/proposals/001-media-type.html#supporting-a-custom-media-type). This step is optional but recommended to make your format a first-class citizen in the toolkit. +1. [Register your new format and add a sniffer](https://readium.org/architecture/specs/001-media-type.html#supporting-a-custom-media-type). This step is optional but recommended to make your format a first-class citizen in the toolkit. 2. Implement a `PublicationParser` to parse the publication format into a `Publication` object. Then, provide an instance to the Streamer. ```swift diff --git a/proposals/006-content-protection.md b/specs/006-content-protection.md similarity index 100% rename from proposals/006-content-protection.md rename to specs/006-content-protection.md diff --git a/proposals/007-search-service.md b/specs/007-search-service.md similarity index 99% rename from proposals/007-search-service.md rename to specs/007-search-service.md index 78915e8..9e49861 100644 --- a/proposals/007-search-service.md +++ b/specs/007-search-service.md @@ -6,7 +6,7 @@ ## Summary -Introduction of a new [publication service](https://readium.org/architecture/proposals/004-publication-helpers-services.html) providing a way to search an excerpt through the content of a publication. +Introduction of a new [publication service](https://readium.org/architecture/specs/004-publication-helpers-services.html) providing a way to search an excerpt through the content of a publication. ## Motivation diff --git a/proposals/008-decorator-api.md b/specs/008-decorator-api.md similarity index 100% rename from proposals/008-decorator-api.md rename to specs/008-decorator-api.md diff --git a/proposals/009-preferences-api.md b/specs/009-preferences-api.md similarity index 100% rename from proposals/009-preferences-api.md rename to specs/009-preferences-api.md diff --git a/proposals/README.md b/specs/README.md similarity index 83% rename from proposals/README.md rename to specs/README.md index ff627d2..3655ffc 100644 --- a/proposals/README.md +++ b/specs/README.md @@ -1,12 +1,12 @@ -# REP - Readium Evolution Proposals +# Readium Specifications -Many changes, such as bug fixes, internal refactorings and documentation improvements, can be implemented and reviewed via the usual GitHub tools: issues and pull requests. +This directory contains the reference specifications for the public APIs of the Readium toolkit. -However, we ask that any change impacting the public API be put through a bit of design process and produce a consensus among the Readium community. +These specifications are living documents: changes to them, including changes impacting the public API, are discussed and made directly against these documents through the usual GitHub tools — issues and pull requests — until they reach consensus among the Readium community. -The REP (Readium Evolution Proposals) process is intended to provide a public space for discussing new features entering the Readium toolkit, so that all stakeholders can be confident about the direction the toolkit is following. It also serves as an archive and reference for existing (or soon to be) features. +This directory used to be `proposals/`, under the Readium Evolution Proposals (REP) process: new features were written up as standalone proposal documents, discussed, and approved before being merged as a historical record. That process is retired. It has been renamed to `specs/` — the documents below still read like proposals (with Motivation, Rationale, Drawbacks sections, etc.) rather than plain reference docs; that has not been rewritten. -## Approved Proposals +## Specifications ### [001 - Media Type](001-media-type.md) diff --git a/proposals/assets/002-archive.svg b/specs/assets/002-archive.svg similarity index 100% rename from proposals/assets/002-archive.svg rename to specs/assets/002-archive.svg diff --git a/proposals/assets/002-audiobook.svg b/specs/assets/002-audiobook.svg similarity index 100% rename from proposals/assets/002-audiobook.svg rename to specs/assets/002-audiobook.svg diff --git a/proposals/assets/002-epub.svg b/specs/assets/002-epub.svg similarity index 100% rename from proposals/assets/002-epub.svg rename to specs/assets/002-epub.svg diff --git a/proposals/assets/002-lcp.svg b/specs/assets/002-lcp.svg similarity index 100% rename from proposals/assets/002-lcp.svg rename to specs/assets/002-lcp.svg diff --git a/proposals/assets/006-open-statechart.svg b/specs/assets/006-open-statechart.svg similarity index 100% rename from proposals/assets/006-open-statechart.svg rename to specs/assets/006-open-statechart.svg diff --git a/proposals/assets/008-bounds-bounds.png b/specs/assets/008-bounds-bounds.png similarity index 100% rename from proposals/assets/008-bounds-bounds.png rename to specs/assets/008-bounds-bounds.png diff --git a/proposals/assets/008-bounds-page.png b/specs/assets/008-bounds-page.png similarity index 100% rename from proposals/assets/008-bounds-page.png rename to specs/assets/008-bounds-page.png diff --git a/proposals/assets/008-bounds-viewport.png b/specs/assets/008-bounds-viewport.png similarity index 100% rename from proposals/assets/008-bounds-viewport.png rename to specs/assets/008-bounds-viewport.png diff --git a/proposals/assets/008-bounds-wrap.png b/specs/assets/008-bounds-wrap.png similarity index 100% rename from proposals/assets/008-bounds-wrap.png rename to specs/assets/008-bounds-wrap.png diff --git a/proposals/assets/008-boxes-bounds.png b/specs/assets/008-boxes-bounds.png similarity index 100% rename from proposals/assets/008-boxes-bounds.png rename to specs/assets/008-boxes-bounds.png diff --git a/proposals/assets/008-boxes-page.png b/specs/assets/008-boxes-page.png similarity index 100% rename from proposals/assets/008-boxes-page.png rename to specs/assets/008-boxes-page.png diff --git a/proposals/assets/008-boxes-viewport.png b/specs/assets/008-boxes-viewport.png similarity index 100% rename from proposals/assets/008-boxes-viewport.png rename to specs/assets/008-boxes-viewport.png diff --git a/proposals/assets/008-boxes-wrap.png b/specs/assets/008-boxes-wrap.png similarity index 100% rename from proposals/assets/008-boxes-wrap.png rename to specs/assets/008-boxes-wrap.png diff --git a/proposals/assets/008-sidemark.png b/specs/assets/008-sidemark.png similarity index 100% rename from proposals/assets/008-sidemark.png rename to specs/assets/008-sidemark.png diff --git a/proposals/assets/009-flow.svg b/specs/assets/009-flow.svg similarity index 100% rename from proposals/assets/009-flow.svg rename to specs/assets/009-flow.svg