Skip to content
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.

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

docs(gitbook): integrate GitBook documentation #285

Merged
merged 3 commits into from
Oct 7, 2024
Merged

Conversation

drichar
Copy link
Collaborator

@drichar drichar commented Oct 7, 2024

Description

This PR integrates the use-wallet GitBook documentation into the monorepo, establishing a foundation for maintaining comprehensive and up-to-date documentation alongside the codebase. It sets up the GitHub Sync integration with GitBook and outlines the workflow for contributors to update documentation.

Details

  • Created docs folder in the repository root to house all GitBook documentation
  • Added initial GitBook documentation content
  • Configured .gitbook.yaml for proper syncing between GitBook and GitHub
  • Set up docs/gitbook branch for GitBook's GitHub Sync integration
  • Added docs/** to .eslintignore and .prettierignore
  • Implemented GitHub Sync integration:
    • Changes made in GitBook UI will be automatically synced to the docs/gitbook branch
    • Updates in docs/gitbook will be reflected in the deployed GitBook documentation
  • Established workflow for contributors:
    • Documentation changes can be included in feature PRs to main
    • After merging to main, changes will be propagated to the docs/gitbook branch
    • This ensures all documentation updates are synced with the deployed GitBook version

@drichar drichar added the documentation Improvements or additions to documentation label Oct 7, 2024
@drichar drichar merged commit d9d96e7 into main Oct 7, 2024
1 check passed
@drichar drichar deleted the docs/gitbook branch October 7, 2024 04:20
@drichar drichar restored the docs/gitbook branch October 7, 2024 04:20
@drichar drichar deleted the docs/gitbook branch October 21, 2024 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant