Skip to content

Commit 4bfd272

Browse files
authored
Update README.md
1 parent 80e9b69 commit 4bfd272

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
1-
# docs
2-
Generates DocC documentation from Swift Bitcoin's repo and deploy to /docs path of the organization's website
1+
# Swift Bitcoin Docs
2+
3+
Generates DocC documentation from Swift Bitcoin's repo and deploy to `/docs` path of the organization's [website](https://swift-bitcoin.github.io/).
4+
5+
## Why separate repo?
6+
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.
8+
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.

0 commit comments

Comments
 (0)