Skip to content

Commit 8dad654

Browse files
BigLepeshon
andauthored
Update README with publishing and access details (#2436)
Added publishing details and GitBook integration information. Closes #2325 Co-authored-by: Eva <1017762+eshon@users.noreply.github.com>
1 parent 3b122d6 commit 8dad654

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,14 @@
1919

2020
## About this repo
2121

22-
This repository manages the documentation for the [Filecoin network](https://filecoin.io). The content is built and hosted by [GitBook](https://github.com). View the docs site at [docs.filecoin.io](https://docs.filecoin.io).
22+
This repository manages the documentation for the [Filecoin network](https://filecoin.io). The content is built and hosted by [GitBook](https://gitbook.com). View the docs site at [docs.filecoin.io](https://docs.filecoin.io).
23+
24+
## Publishing
25+
This repo is synced to [GitBook](https://gitbook.com) using [GitBook's GitSync](https://gitbook.com/docs/getting-started/git-sync). When a PR to `main` is merged, a new GitBook is published. This happens as a result of the GitBook applicaiton, not a GitHub Action workflow in the repo.
26+
27+
PRs also generate preview links so one can preview the site before merging. Per [GitBook GitSync integration](https://app.gitbook.com/o/NNmD4UvLc26b1TmEYgzE/s/xNWFG7bQkjLkl5BBGjbD/~/integrations/github), preview links from fork PRs have been enabled.
28+
29+
[SEAD](https://sead.ai/) has admin access to the Filecoin GitBook organization. Access can be requested through the FIL Slack #sead-filecoinio-support.
2330

2431
## Contributing
2532

@@ -32,6 +39,8 @@ Links are checked using [lychee-action](https://github.com/lycheeverse/lychee-ac
3239
2. wrap it in `<code>` blocks OR
3340
3. use [`.lycheeignore`](https://github.com/lycheeverse/lychee-action?tab=readme-ov-file#excluding-links-from-getting-checked)
3441

42+
43+
3544
## Issues
3645

3746
Found a problem with the Filecoin docs site? [Please raise an issue](https://github.com/filecoin-project/filecoin-docs/issues/new). Be as specific and descriptive as possible; screenshots help!

0 commit comments

Comments
 (0)