Skip to content

Commit 8347a85

Browse files
nojafdawedawe
andauthored
Apply suggestions from code review
Co-authored-by: dawe <[email protected]>
1 parent 29a75be commit 8347a85

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/zero-to-hero.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ index: 9
55
---
66
# From zero to hero: deploying to GitHub Pages
77

8-
This guide is meant for a typically setup for open-source projects on GitHub.
8+
This guide is meant for a typical setup of open-source projects on GitHub.
99
We start from a repository without any documentation and aim to end up with a published website on [GitHub Pages](https://pages.github.com/).
1010

1111
## Install the local tool
@@ -44,7 +44,7 @@ When `fsdocs` runs, it will transform this `index.md` file to `index.html`, whic
4444

4545
We can put `# Hello world` in the markdown file for now.
4646

47-
Having this in play, should already serve the first page when we start the `watch` command:
47+
Having this in place, should already serve the first page when we start the `watch` command:
4848

4949
> dotnet fsdocs watch
5050
@@ -63,7 +63,7 @@ It will filter these found projects, the requirements are:
6363
- Not having `<IsTestProject>true</IsTestProject>`
6464
- Having `<GenerateDocumentationFile>true</GenerateDocumentationFile>`
6565

66-
🪄 If you made some changes to in order to adhere to the rules, you may want to remove the `.fsdocs/cache` file.
66+
🪄 If you made some changes in order to adhere to the rules, you may want to remove the `.fsdocs/cache` file.
6767

6868
## Adding the missing properties
6969

@@ -100,9 +100,9 @@ Running `dotnet fsdocs watch` will now yield:
100100
⚠️ Again, you might need to remove `.fsdocs/cache` in order for changes to be picked up!
101101

102102
`<PackageProjectUrl>` is actually a very important property when you run `dotnet fsdocs build`.
103-
`build` will generated static files for the targeted production environment. In our case, this will be GitHub Pages.
103+
`build` will generate static files for the targeted production environment. In our case, this will be GitHub Pages.
104104

105-
Pages will host your files from https://github.com/user/project to on `https://user.github.io/project/` by default.
105+
Pages will host your files from https://github.com/user/project on `https://user.github.io/project/` by default.
106106
You can change this by adding a custom domain so we need to be sure that all links and urls will be generated correctly during a build.
107107

108108
Let's now run `dotnet fsdocs build`.
@@ -113,7 +113,7 @@ Let's now run `dotnet fsdocs build`.
113113

114114
## Ignore generated files
115115

116-
Alright, at this point we've made a lot of progress. I you are using `git` you want to add the following to your [.gitignore](https://git-scm.com/docs/gitignore) file.
116+
Alright, at this point we've made a lot of progress. If you are using `git` you want to add the following to your [.gitignore](https://git-scm.com/docs/gitignore) file.
117117

118118
```.ignorelang
119119
# FSharp.Formatting
@@ -189,7 +189,7 @@ jobs:
189189
190190
## Next steps
191191
192-
Mission accomplished right? If everything went well, you should have a published website at this point!
192+
Mission accomplished, right? If everything went well, you should have a published website at this point!
193193
Here are some next steps you could consider:
194194
195195
### Use fsx file in your documentation

0 commit comments

Comments
 (0)