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

Move documentation to Gitbook #206

Merged
merged 7 commits into from
Apr 6, 2023
Merged

Conversation

unfulvio-godaddy
Copy link
Member

@unfulvio-godaddy unfulvio-godaddy commented Mar 17, 2023

Summary

This PR moves the bulk of the documentation from the README.md file over to /docs which can be handled by Gitbook.

This is a preview of how it will look like: https://wp-mock.gitbook.io/documentation/general/introduction but the source of truth will be this PR - the current copy on GitBook is not synced with Git currently and incomplete. I think we need to initiate a diff from this repo, sync won't be bidirectional.

Note that the sources of documentation will always be in this repository under /docs -- if some day we switch away from GitBook the documentation will still be readable - as a matter of fact can be read from within the repository. Editing the docs will also be easy through regular PRs.

For a preview of the updated README.md: https://github.com/10up/wp_mock/tree/chore/move-docs-to-gitbook

Closes: #199

Details

After this is merged we need to make sure the docs will be properly synced to Gitbook from the markdown files in /docs.

The CREDITS.md file is removed - the list of contributors is automatically generated by GitHub and furthermore we can make attributions in the generated changelogs. There's no need to manually maintain a static file of contributors.

@unfulvio-godaddy unfulvio-godaddy self-assigned this Mar 17, 2023
@unfulvio-godaddy unfulvio-godaddy added the Documentation Updates to documentation label Mar 17, 2023
@coveralls
Copy link

coveralls commented Mar 17, 2023

Coverage Status

Coverage: 41.94%. Remained the same when pulling 6b8eaaa on chore/move-docs-to-gitbook into 4a46042 on trunk.

@unfulvio-godaddy unfulvio-godaddy marked this pull request as ready for review March 28, 2023 07:08
@unfulvio-godaddy unfulvio-godaddy requested review from jeffpaul and a team March 28, 2023 07:23
Copy link
Member

@jeffpaul jeffpaul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've not tested that these changes actually work as desired with Gitbook, but they otherwise look to properly move the docs correctly

@unfulvio-godaddy unfulvio-godaddy merged commit b6fa907 into trunk Apr 6, 2023
@unfulvio-godaddy unfulvio-godaddy deleted the chore/move-docs-to-gitbook branch April 6, 2023 09:06
@jeffpaul jeffpaul added this to the 0.6.0 milestone May 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Updates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move documentation over GitBook
3 participants