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.

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

Jump to bottom

Move documentation over GitBook #199

Closed
unfulvio-godaddy opened this issue Jan 12, 2023 · 0 comments · Fixed by #206
Closed

Move documentation over GitBook #199

unfulvio-godaddy opened this issue Jan 12, 2023 · 0 comments · Fixed by #206
Assignees
@unfulvio-godaddy
Labels
Documentation Updates to documentation
Milestone
v1.0.0

Comments

@unfulvio-godaddy
Copy link
Member

GitBook kindly granted a community plan to WP_Mock - we can break the uber-long readme.md file into a more coherent documentation for WP_Mock.

We can keep the docs in MD format, with no additional build tools and manage presentation and versioning via GitBook. The MD source files will stay in this repository.

Steps to bring this online:

  1. Integrate the repository with GitBook (already connected needs to finish integration)
  2. Discuss initial docs structure
  3. Move docs into proposed structure
  4. Update Readme.md file with a more succinct introduction to WP_Mock (keep current badges, links to docs contributors page, etc.)
@unfulvio-godaddy unfulvio-godaddy added the Documentation Updates to documentation label Jan 12, 2023
@unfulvio-godaddy unfulvio-godaddy self-assigned this Jan 12, 2023
This was referenced Jan 13, 2023
Merged
Merged
agibson-godaddy pushed a commit that referenced this issue Jan 13, 2023
@unfulvio-godaddy
Add gitbook.yaml (#201)
2d3b0fc 
<!--
Filling out the required portions of this template is mandatory. 
Any PR that does not include enough information to be reviewed may be
closed at a maintainers' discretion.
All new code requires associated documentation and unit tests.
-->

# Summary <!-- Required -->

Adds a `gitbook.yaml` file to exclude syncing doc files outside of the
`docs` folder in the git repository root.

Will also point to an `intrroduction.md` file as the main docs page (to
avoid confusion with readme.md).

Readme, changelog etc. in the git root are not expected to be handled by
GitBook.

See #199.

### Reviewer checklist <!-- Required -->

<!-- The following checklist is for the reviewer: add any steps that may
be relevant while reviewing this pull request -->

- [ ] Code changes review
- [x] Documentation changes review
- [x] Unit tests pass
- [x] Static analysis passes
@unfulvio-godaddy unfulvio-godaddy mentioned this issue Mar 17, 2023
Merged
@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
Assignees

@unfulvio-godaddy unfulvio-godaddy

Labels
Documentation Updates to documentation
Projects
None yet
Milestone
v1.0.0
Development

Successfully merging a pull request may close this issue.

Move documentation to Gitbook 10up/wp_mock
2 participants
@jeffpaul @unfulvio-godaddy