diff --git a/docs/README.md b/docs/README.md index 9beb2e0..4650e79 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,4 +2,4 @@ This directory contains the documentation for `amphp/amp`. Documentation and code are bundled within a single repository for easier maintenance. Additionally, this preserves the documentation for older versions. -Start with the [Introduction to Event Loops](./event-loop.md). +Start with the [Introduction to Event Loops](./event-loop/). diff --git a/docs/coroutines/README.md b/docs/coroutines/README.md new file mode 100644 index 0000000..837ec4a --- /dev/null +++ b/docs/coroutines/README.md @@ -0,0 +1,3 @@ +# Streams + +This is a documentation stub. Please help writing this documentation. See [#90](https://github.com/amphp/amp/issues/90). diff --git a/docs/event-loop.md b/docs/event-loop/README.md similarity index 98% rename from docs/event-loop.md rename to docs/event-loop/README.md index cdac05d..64c993d 100644 --- a/docs/event-loop.md +++ b/docs/event-loop/README.md @@ -106,4 +106,4 @@ var_dump($myText); // whatever you input on the CLI Obviously we could have simply used `fgets(STDIN)` synchronously in this example. We're just demonstrating that it's possible to move in and out of the event loop to mix synchronous tasks with non-blocking tasks as needed. -Continue with the [Event Loop API](./event-loop-api.md). +Continue with the [Event Loop API](./api.md). diff --git a/docs/event-loop-api.md b/docs/event-loop/api.md similarity index 100% rename from docs/event-loop-api.md rename to docs/event-loop/api.md diff --git a/docs/promises/README.md b/docs/promises/README.md new file mode 100644 index 0000000..e0029c2 --- /dev/null +++ b/docs/promises/README.md @@ -0,0 +1,3 @@ +# Promises + +This is a documentation stub. Please help writing this documentation. See [#97](https://github.com/amphp/amp/issues/97). diff --git a/docs/promises/combinators.md b/docs/promises/combinators.md new file mode 100644 index 0000000..ef5493a --- /dev/null +++ b/docs/promises/combinators.md @@ -0,0 +1,3 @@ +# Promise Combinators + +This is a documentation stub. Please help writing this documentation. See [#102](https://github.com/amphp/amp/issues/102). diff --git a/docs/promises/miscellaneous.md b/docs/promises/miscellaneous.md new file mode 100644 index 0000000..02c3d89 --- /dev/null +++ b/docs/promises/miscellaneous.md @@ -0,0 +1,3 @@ +# Promise Helpers + +This is a documentation stub. Please help writing this documentation. See [#104](https://github.com/amphp/amp/issues/104). diff --git a/docs/promises/transformation.md b/docs/promises/transformation.md new file mode 100644 index 0000000..38d34d5 --- /dev/null +++ b/docs/promises/transformation.md @@ -0,0 +1,3 @@ +# Promise Transformation + +This is a documentation stub. Please help writing this documentation. See [#103](https://github.com/amphp/amp/issues/103). diff --git a/docs/streams/README.md b/docs/streams/README.md new file mode 100644 index 0000000..ca65573 --- /dev/null +++ b/docs/streams/README.md @@ -0,0 +1,3 @@ +# Streams + +This is a documentation stub. Please help writing this documentation. See [#91](https://github.com/amphp/amp/issues/91) and [#99](https://github.com/amphp/amp/issues/99). diff --git a/docs/streams/combinators.md b/docs/streams/combinators.md new file mode 100644 index 0000000..4b9d32c --- /dev/null +++ b/docs/streams/combinators.md @@ -0,0 +1,3 @@ +# Stream Combinators + +This is a documentation stub. Please help writing this documentation. See [#106](https://github.com/amphp/amp/issues/106). diff --git a/docs/streams/transformation.md b/docs/streams/transformation.md new file mode 100644 index 0000000..e5967c0 --- /dev/null +++ b/docs/streams/transformation.md @@ -0,0 +1,3 @@ +# Promise Transformation + +This is a documentation stub. Please help writing this documentation. See [#105](https://github.com/amphp/amp/issues/105).