Skip to content

Commit

Permalink
Fix broken links in multiple markdown doc files
Browse files Browse the repository at this point in the history
- README
- docs/unified-abstractions.md
- docs/getting-started.md
- docs/streamly-vs-async.md
- docs/Overview.md
- docs/faq.md
- CONTRIBUTING.md
- benchmark/README.md
  • Loading branch information
adithyaov committed Feb 6, 2022
1 parent 643c093 commit 8ab2bfd
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 18 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ BRANCH.

It is a good idea to include tests for the changes where applicable. See
the existing tests in the [test](test) directory. Also see the
[test/README](test/README) for more details on how to run the tests.
[test/README.md](test/README.md) for more details on how to run the tests.

### Documentation

Expand All @@ -163,13 +163,13 @@ any of the existing performance benchmarks. If you introduced something new
then you may want to add benchmarks to check if it performs as well as expected
by the programmers to deem it usable.

See the [README](benchmark/README) file in the `benchmark` directory for more
See the [README](benchmark/README.md) file in the `benchmark` directory for more
details on how to run the benchmarks.

The first level of check is the regression in "allocations", this is
the most stable measure of regression. "bytesCopied" is another stable
measure, it gives an idea of the amount of long lived data being copied
across generations of GC.
across generations of GC.

The next measure to look at is "cpuTime" this may have some variance
from run to run because of factors like cpu frequency scaling, load on
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ sys 0m0.140s
```

These example programs have assumed ASCII encoded input data. For UTF-8
streams, we have a [concurrent wc implementation][WordCountUTF8.hs]
streams, we have a [concurrent wc implementation][WordCountParallelUTF8.hs]
with UTF-8 decoding. This concurrent implementation performs as well
as the standard `wc` program in serial benchmarks. In concurrent mode
[Streamly][]'s implementation can utilise multiple processing cores if
Expand Down Expand Up @@ -595,7 +595,7 @@ significant way:
* Gabriella Gonzalez ([foldl](https://hackage.haskell.org/package/foldl))
* Alberto G. Corona ([transient](https://hackage.haskell.org/package/transient))

Please see the [`credits`](./credits/README.md) directory for a full
Please see the [`credits`](./docs/Credits.md) directory for a full
list of contributors, credits and licenses.

## Licensing
Expand Down Expand Up @@ -637,7 +637,7 @@ links (for online docs) before we release.
[WordCount.hs]: https://github.com/composewell/streamly-examples/blob/master/examples/WordCount.hs
[WordCount.c]: https://github.com/composewell/streamly-examples/blob/master/examples/WordCount.c
[WordCountParallel.hs]: https://github.com/composewell/streamly-examples/blob/master/examples/WordCountParallel.hs
[WordCountUTF8.hs]: https://github.com/composewell/streamly-examples/blob/master/examples/WordCountUTF8.hs
[WordCountParallelUTF8.hs]: https://github.com/composewell/streamly-examples/blob/master/examples/WordCountParallelUTF8.hs
[WordServer.hs]: https://github.com/composewell/streamly-examples/blob/master/examples/WordServer.hs
[MergeServer.hs]: https://github.com/composewell/streamly-examples/blob/master/examples/MergeServer.hs
[ListDir.hs]: https://github.com/composewell/streamly-examples/blob/master/examples/ListDir.hs
Expand Down
2 changes: 1 addition & 1 deletion benchmark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ they are usually annotated so in their documentation.
### Resolving the problem

Review the problematic code, see [the optimization
guide](dev/optimization-guidelines.md) for common problems and how to
guide](../dev/optimization-guidelines.md) for common problems and how to
solve those. If no obvious issues are found on review, then generate and
examine the core.

Expand Down
4 changes: 2 additions & 2 deletions docs/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ can be constructed from monadic effects, not just pure elements. Streams are
processed just like lists, with list like combinators, except that they are
monadic and work in a streaming fashion. In other words streamly just completes
what lists lack, you do not need to learn anything new. Please see [streamly vs
lists](docs/streamly-vs-lists.md) for a detailed comparison.
lists](streamly-vs-lists.md) for a detailed comparison.

Not surprisingly, the monad instance of streamly is a list transformer, with
concurrency capability.
Expand Down Expand Up @@ -369,7 +369,7 @@ using streamly. You can compile these with `ghc -O2 -fspec-constr-recursive=16
-fmax-worker-args=16` and compare the performance with regular GNU coreutils
available on your system. Though many of these are not most optimal solutions
to keep them short and elegant. Source file
[HandleIO.hs](https://github.com/composewell/streamly-examples/tree/master/examples/HandleIO.hs)
[CoreUtilsHandle.hs](https://github.com/composewell/streamly-examples/blob/master/examples/CoreUtilsHandle.hs)
in the examples directory includes these examples.

``` haskell
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This document provides idioms or examples to solve common programming
problems using streamly. To start with please go through [Streamly Quick
Overview](README.md) and [`Streamly examples repository`][streamly-examples].
Overview](../README.md) and [`Streamly examples repository`][streamly-examples].
This document provides additional examples.

## Distribute and Zip Concurrently
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,11 +279,11 @@ streamly][streamly-github] on Github.
If you got this far successfully, congratulations!

* For an overview of the `streamly` package, please read the
[Streamly Quick Overview](README.md).
[Streamly Quick Overview](../README.md).
* Please browse the code examples in the
[`Streamly examples repository`][streamly-examples].
* If you would like to start on a real world project, please take a
look at the [Streamly Build Guide](./docs/building.md).
look at the [Streamly Build Guide](building.md).
* For comprehensive documentation please visit the
[Streamly Homepage][Streamly].

Expand Down
2 changes: 1 addition & 1 deletion docs/streamly-vs-async.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ the concurrent actions are executed.

See the [haddock documentation on
hackage](https://hackage.haskell.org/package/streamly) and [a comprehensive tutorial
here](https://hackage.haskell.org/package/streamly/docs/Streamly-Tutorial.html).
here](https://streamly.composewell.com/streamly-0.8.1/Tutorial.html).

## References

Expand Down
13 changes: 8 additions & 5 deletions docs/unified-abstractions.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,10 +189,8 @@ All this comes with no change in the streaming APIs.
The combination of non-determinism, concurrency, and streaming makes
Streamly a strong reactive programming library as well. Reactive
programming fundamentally deals with streams of events that can be
processed concurrently. The
[https://github.com/composewell/streamly-examples/tree/master/AcidRain.hs](Acid
Rain) and [Circling
Square](https://github.com/composewell/streamly-examples/tree/master/CirclingSquare.hs)
processed concurrently. The [Acid Rain][AcidRain.hs] and
[Circling Square][CirclingSquare.hs]
examples demonstrate the basic reactive capability of Streamly.

In core concepts, Streamly is strikingly similar to `dunai`. `dunai` was
Expand Down Expand Up @@ -228,7 +226,7 @@ concise manner. Some key points that Streamly stresses are:
then you know how to use Streamly. This library is built with simplicity
and ease of use as a design goal.
* _Concurrency_: Simple, powerful, and scalable concurrency. Concurrency is
built-in, and not intrusive, concurrent programs are written exactly
built-in, and not intrusive, concurrent programs are written exactly
as non-concurrent ones.
* _Generality_: Unifies functionality provided by several disparate packages
(streaming, concurrency, list transformer, logic programming, reactive
Expand Down Expand Up @@ -270,3 +268,8 @@ libraries:
### Arrays

* [vector](https://hackage.haskell.org/package/vector)

<!-- Markdown Links -->

[AcidRain.hs]: https://github.com/composewell/streamly-examples/blob/master/examples/AcidRain.hs
[CirclingSquare.hs]: https://github.com/composewell/streamly-examples/blob/master/examples/CirclingSquare.hs

0 comments on commit 8ab2bfd

Please sign in to comment.