Fix some bad links in the guides
This commit is contained in:
parent
45b2dc69b6
commit
4408ad399d
@ -39,13 +39,14 @@ this end, documentation should mostly be provided inline in the codebase, and
|
||||
should follow the same PR process as other commits.
|
||||
|
||||
We also welcome documentation in the form of guides and examples. These should
|
||||
live in the [docs](docs) directory. Please ensure all guides are written in
|
||||
markdown format, and all examples are fully-functional and implemented as
|
||||
self-contained subdirectories under [docs/examples](docs/examples).
|
||||
live in the [Documentation](Documentation) directory. Please ensure all guides
|
||||
are written in markdown format, and all examples are fully-functional and
|
||||
implemented as self-contained subdirectories
|
||||
under [Documentation/Examples](Documentation/Examples).
|
||||
|
||||
All examples should have corresponding integration tests, to ensure that
|
||||
examples we promote remain functional. If you plan to contribute examples,
|
||||
please take a look at [IntegrationSpec.purs](test/HTTPure/IntegrationSpec.purs).
|
||||
please take a look at [IntegrationSpec.purs](Test/HTTPure/IntegrationSpec.purs).
|
||||
|
||||
### Code
|
||||
|
||||
|
12
Readme.md
12
Readme.md
@ -13,7 +13,7 @@ production-ready yet. You can track what's left before it gets production-ready
|
||||
by looking at
|
||||
our [roadmap](https://github.com/cprussin/purescript-httpure/projects). If you'd
|
||||
like to help us get there quicker, please contribute! To get started, check
|
||||
our [contributing guide](CONTRIBUTING.md).
|
||||
our [contributing guide](Contributing.md).
|
||||
|
||||
## Installation
|
||||
|
||||
@ -50,8 +50,8 @@ on [Pursuit](http://pursuit.purescript.org/packages/purescript-httpure).
|
||||
|
||||
## Examples
|
||||
|
||||
HTTPure ships with a number of [examples](docs/examples). To run an example,
|
||||
in the project root, run:
|
||||
HTTPure ships with a number of [examples](Documentation/Examples). To run an
|
||||
example, in the project root, run:
|
||||
|
||||
```bash
|
||||
make example EXAMPLE=<Example Name>
|
||||
@ -71,7 +71,7 @@ make test
|
||||
## Contributing
|
||||
|
||||
We are open to accepting contributions! Please see
|
||||
the [contributing guide](CONTRIBUTING.md).
|
||||
the [contributing guide](Contributing.md).
|
||||
|
||||
## People
|
||||
|
||||
@ -79,8 +79,8 @@ HTTPure is written and maintained
|
||||
by [Connor Prussin](https://connor.prussin.net).
|
||||
|
||||
We are open to accepting contributions! Please see
|
||||
the [contributing guide](CONTRIBUTING.md).
|
||||
the [contributing guide](Contributing.md).
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
[MIT](License)
|
||||
|
Loading…
Reference in New Issue
Block a user