From 865634972fbfa3d120f97d381e39f48c85dc7d80 Mon Sep 17 00:00:00 2001 From: Sean Madsen <sean@seanmadsen.com> Date: Wed, 14 Jun 2017 17:16:53 -0600 Subject: [PATCH] Fix broken links --- docs/documentation/index.md | 10 +++++----- docs/documentation/style-guide.md | 2 +- docs/index.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/documentation/index.md b/docs/documentation/index.md index ec4a5113..3db22980 100644 --- a/docs/documentation/index.md +++ b/docs/documentation/index.md @@ -14,7 +14,7 @@ This page describes the details of the documentation systems within CiviCRM and ## Guide books in MkDocs -We are using [MkDocs](http://www.mkdocs.org) to produce books. The content for each of these books is written in [markdown](/markdownrules.md), stored in text files, and hosted in a repository on GitHub. Then, the books are automatically published to [docs.civicrm.org](https://docs.civicrm.org) using our custom [publishing system](https://github.com/civicrm/civicrm-docs). +We are using [MkDocs](http://www.mkdocs.org) to produce books. The content for each of these books is written in [markdown](/documentation/markdown.md), stored in text files, and hosted in a repository on GitHub. Then, the books are automatically published to [docs.civicrm.org](https://docs.civicrm.org) using our custom [publishing system](https://github.com/civicrm/civicrm-docs). ### Versions @@ -39,9 +39,9 @@ We welcome contributions, small and large, to documentation! Before diving into editing, you may find helpful information within the following resources: -- [Markdown syntax](/markdownrules.md) - necessary (but simple) syntax to format content -- [Markdown code standards](/markdownrules.md#standards) - recommendations for markdown syntax to use -- [Style guide](/best-practices/documentation-style-guide.md) - to maintain consistent language and formatting +- [Markdown syntax](/documentation/markdown.md) - necessary (but simple) syntax to format content +- [Markdown code standards](/documentation/markdown.md#standards) - recommendations for markdown syntax to use +- [Style guide](/documentation/style-guide.md) - to maintain consistent language and formatting - [Documentation chat room](https://chat.civicrm.org/civicrm/channels/documentation) - live discussion, fast (most of the time) answers to your questions - [Documentation mailing list](https://lists.civicrm.org/lists/info/civicrm-docs) - low traffic, mostly used for informational updates regarding documentation projects @@ -97,7 +97,7 @@ The most advanced way to work on a book is to use git to download all the markdo 1. View the book locally your browser at `http://localhost:8000`. -1. Edit the [markdown](/markdownrules.md) with an editor of your choice. As you +1. Edit the [markdown](/documentation/markdown.md) with an editor of your choice. As you save your changes `mkdocs` will automatically reprocess the page and refresh your browser. diff --git a/docs/documentation/style-guide.md b/docs/documentation/style-guide.md index c5727bf0..06530cb8 100644 --- a/docs/documentation/style-guide.md +++ b/docs/documentation/style-guide.md @@ -1,7 +1,7 @@ # Documentation style guide All CiviCRM guides *(like this Developer Guide)* are intended to provide -high-quality "finished" [documentation](/documentation.md) +high-quality "finished" [documentation](/documentation/index.md) about CiviCRM. This Style Guide page documents the standards we wish to uphold to ensure all guides maintain this high level of quality. diff --git a/docs/index.md b/docs/index.md index c1b16ff1..a048e1b3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,7 +29,7 @@ for use by people that are familiar with CiviCRM development. - This documentation is made with mkdocs and [stored in GitHub](https://github.com/civicrm/civicrm-dev-docs) -- See the "[Writing Documentation](documentation.md)" section in this guide +- See the "[Writing Documentation](documentation/index.md)" section in this guide for specific details on editing this documentation (and others using mkdocs). You can also learn how to read these docs off-line! -- GitLab