Merge pull request #2426 from uzluisf/master

whitespace and text reflow

documention -> documentation

CONTRIBUTING.md

@@ -5,10 +5,9 @@ Your patches to perl6/doc are very welcome.
 This document describes how to get started and helps to provide documentation
 that adheres to the common style and formatting guidelines.
 
-Your contributions here will be credited in the next Rakudo release announcement. Your name from
-the commit log will be used. If you'd like to be credited under a different name,
-please add it to the local
-[CREDITS](CREDITS)
+Your contributions here will be credited in the next Rakudo release
+announcement. Your name from the commit log will be used. If you'd like to be
+credited under a different name, please add it to the local [CREDITS](CREDITS)
 file (or ask someone to do it for you until you have commit privileges).
 
 If you have any questions regarding contributing to this project, please ask
@@ -45,17 +44,17 @@ in the [#perl6 IRC channel](https://perl6.org/community/irc).
 * Be explicit about routine signatures. If a method accepts an `*%args`,
   but treats some of them specially, list them separately.
 * Check out [the styleguide](writing-docs/STYLEGUIDE.md) for further guidance.
-* If you are participating in one of the monthly
-  squashathons,
+* If you are participating in one of the monthly squashathons,
   [please read this guide](writing-docs/SQUASHATHONS.md).
 
 ## Documenting versions
 
-* If you are adding a recently introduced feature, please indicate in a note which version it was introduced in.
+* If you are adding a recently introduced feature, please indicate in a note
+  which version it was introduced in.
 * If you change an example to use the new feature, leave the old
-  example if it's still working, at least while it's not obsolete, for people who have not
-  upgraded yet, clarifying in the text around it the versions it will
-  run with.
+  example if it's still working, at least while it's not obsolete, for people
+  who have not upgraded yet, clarifying in the text around it the versions it
+  will run with.
 
 ## Writing Code Examples
 
@@ -64,9 +63,9 @@ available when writing code examples in the documentation.
 
 ## Adding a new Language document
 
-We suggest you discuss proposing a new Language document on the #perl6 channel before
-you proceed further. After you get consensus on a title, subtitle, section, and
-filename, you can add the document by following these steps:
+We suggest you discuss proposing a new Language document on the #perl6 channel
+before you proceed further. After you get consensus on a title, subtitle,
+section, and filename, you can add the document by following these steps:
 
 + create a **filename.pod6** file in the **doc/Language** directory and
   ensure it adheres to the conventions in
@@ -82,7 +81,7 @@ The Pod 6 documentation of types is located in the `doc/Type` directory and
 subdirectories of this repository. For example the Pod 6 file of `X::Bind::Slice`
 lives in `doc/Type/X/Bind/Slice.pod6`.
 
-To start contributing fork and checkout the repository, find the document
+To start contributing, fork and checkout the repository, find the document
 you want to improve, commit your changes, and create a pull request. Should
 questions come up in the process feel free to ask in
 [#perl6 IRC channel](https://perl6.org/community/irc).
@@ -121,7 +120,7 @@ When documenting a pair of a sub and a method with the same functionality, the
 heading should be `=head2 routine do-it`, and the next thing should be two or
 more lines with the signatures. Other allowed words instead of `method` are
 `sub`, `trait`, `infix`, `prefix`, `postfix`, `circumfix`, `postcircumfix`,
-`term`. If you wish to hide a heading from any index prefix it with the empty
+`term`. If you wish to hide a heading from any index, prefix it with the empty
 comment `Z<>`.
 
 When providing a code example result or output, use this style:
@@ -157,8 +156,8 @@ See [Writing and Testing Examples](writing-docs/EXAMPLES.md)
 
 ## Testing method completeness
 
-To get a list of methods that are found via introspection but not
-found in any Pod 6 file under `doc/Type/`, use `util/list-missing-methods.p6`. It takes a
+To get a list of methods that are found via introspection but not found in any
+Pod 6 file under `doc/Type/`, use `util/list-missing-methods.p6`. It takes a
 directory or filepath as argument and limits the listing to the given file or
 any Pod 6-files found. All methods listed in `util/ignored-methods.txt` are
 ignored.
@@ -170,7 +169,7 @@ the page to activate debug mode. The state of debug mode will be remembered by
 `window.sessionStorage` and will not survive a browser restart or opening the
 docs in a new tab.
 
-q### Invisible index anchors
+### Invisible index anchors
 
 You can create index entries and invisible anchors with `X<|thing,category>`.
 To make them visible activate debug mode.
@@ -210,7 +209,7 @@ If you would like to contribute documentation or other bug fixes, please use
 Assuming that you have already forked and cloned the
 [perl6/doc](https://github.com/perl6/doc) repository, one of the first things
 you probably want to do is to build the documentation on your local
-computer.  To do this you will need:
+computer. To do this you will need:
 
   - Perl 6 (e.g., the Rakudo Perl 6 implementation)
   - zef (the installer for third party Perl 6 modules)
@@ -293,7 +292,7 @@ To actually build the documentation all you now need to do is run:
 This takes a while, but be patient!
 
 After the build has completed, you can start the web application which will
-render the HTML documention on a web server on your build host:
+render the HTML documentation on a web server on your build host:
 
     $ make run
 
@@ -302,12 +301,14 @@ documentation.
 
 #### Using Docker to build and view the documentation
 
-You can skip all the above and just build and view documentation with these simple commands (if you have docker already installed):
+You can skip all the above and just build and view documentation with these
+simple commands (if you have docker already installed):
 
     $ docker build -t perl6-doc .
     $ docker run -p 3000:3000 -it -v `pwd`:/perl6/doc perl6-doc
 
-This will build the documentation for you by default and it will take some time, but for subsequent use you may want to skip build part if nothing has been changed:
+This will build the documentation for you by default and it will take some time,
+but for subsequent use you may want to skip build part if nothing has been changed:
 
     $ docker run -p 3000:3000 -it -v `pwd`:/perl6/doc perl6-doc ./app-start
 
@@ -325,14 +326,14 @@ To run the development web server for viewing documentation (on port 3000):
 
     $ make docker-run
 
-Note that while this requires less typing, some assumptions will be made for you regarding the name
-of the resulting image, the port the content is available over, etc. If you want, you can
-override these default values.
+Note that while this requires less typing, some assumptions will be made for
+you regarding the name of the resulting image, the port the content is available
+over, etc. If you want, you can override these default values.
 
-For instance, if you want the local documentation to be available over port 5001 of the host,
-pass the following to make when running:
+For instance, if you want the local documentation to be available over port 5001
+of the host, pass the following to make when running:
 
     $ make docker-run DOCKER_HOST_PORT=5001
 
-Now the documentation will be available on the host at http://localhost:5001. Please see the
-Makefile for a list of available options.
+Now the documentation will be available on the host at http://localhost:5001.
+Please see the Makefile for a list of available options.