Skip to content

Migrate /docs folder to /gitbook and Move entire documentation to Gitbook - #47

Open
anshuman-dev wants to merge 17 commits into
ChaosChain:masterfrom
anshuman-dev:master
Open

Migrate /docs folder to /gitbook and Move entire documentation to Gitbook#47
anshuman-dev wants to merge 17 commits into
ChaosChain:masterfrom
anshuman-dev:master

Conversation

@anshuman-dev

Copy link
Copy Markdown

This PR achieves the following:

  • Move all the markdown files and content from /docs folder to a /gitbook folder to better organize the documentation
  • Setup GitBook integration for improved documentation experience
  • Restructure documentation with better navigation and organization
  • Remove the /docs directory after successful migration

The migration has been tested and works properly on the forked repository at anshuman-dev/chaoschain.

For the GitBook integration to work with the main repository after merging this PR, there are two options with us:

Transfer an existing GitBook space:

  • If preferred, I can transfer my existing GitBook space with all the configurations
  • Would need to invite a maintainer with appropriate permissions
  • After transfer, reconfigure the GitHub integration to point to this repository

Set up a new GitBook space:

  • Create a new GitBook space
  • Connect to this repository (NethermindEth/chaoschain)
  • Set the sync to pull from the master branch

It would also involve updating the root directory to /gitbook in the .gitbook.yaml file as well.

@SumeetChougule

Copy link
Copy Markdown
Contributor

Hi, thanks for the request. I was working on the gitbook here https://github.com/SumeetChougule/chaoschain/tree/documentation and https://chaoschain.gitbook.io/chaos so feel free to take it forward from there

@astryp212

Copy link
Copy Markdown

Hi, how are you doing?
I am a blockchain developer with over 5 years of experience.
I have read your docs and checked your repo carefully and really interested in your project.
Are there any opportunity for me to work in your team?
Pls connect with me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

4 participants