Skip to content

Commit 7502b13

Browse files
authored
Update README.md
1 parent 4bfd272 commit 7502b13

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Swift Bitcoin Docs
22

3-
Generates DocC documentation from Swift Bitcoin's repo and deploy to `/docs` path of the organization's [website](https://swift-bitcoin.github.io/).
3+
Generates DocC documentation from Swift Bitcoin's repo and deploy to [/docs](https://swift-bitcoin.github.io/docs/documentation/bitcoin) path of the organization's website.
44

55
## Why separate repo?
66

7-
Because it's easy to checkout Repo B (e.g. `swift-bitcoin` repo) from a GH Action running on Repo A (e.g. this repo) and later deploy to repo A's GH Pages. But it is not at all possible to run an action on Repo B and have it deploy artifacts another repo/org's GH pages.
7+
Because it's simple enough to checkout Repo B (e.g. `swift-bitcoin` repo) from a GitHub Action running on Repo A (e.g. this repo) and deploy the generated docs to Repo A's GitHub Pages URL while it is not at all possible to run an Action directly on Repo B and have it deploy the docs artifacts to a different repo's Pages URL (or to the organization's Pages URL).
88

9-
Having a standalone docs repo with Pages will create the subfolder needed to host the documentation pages generated independently from the main site/blog.
9+
Having a standalone docs repo with Pages on will also create the subfolder needed (in this case _docs_) to host the documentation pages generated independently from the main site and blog.

0 commit comments

Comments
 (0)