Skip to content

Update README with publishing and access details #2436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README with publishing and access details #2436

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b176ec
Update README with publishing and access details
BigLep Nov 3, 2025
9750b83
Merge branch 'main' into biglep/document-publishing
eshon Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,14 @@

## About this repo

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).
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).

## Publishing
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.

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.

[SEAD](https://sead.ai/) has admin access to the Filecoin GitBook organization. Access can be requested through the FIL Slack #sead-filecoinio-support.

## Contributing

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



## Issues

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!
Expand Down
Loading