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

Rough outline to doc automatation #34

Closed
rahul286 opened this issue Nov 16, 2018 · 1 comment
Closed

Rough outline to doc automatation #34

rahul286 opened this issue Nov 16, 2018 · 1 comment
Labels
programming Coding tasks related to docs automation

Comments

@rahul286
Copy link
Member

rahul286 commented Nov 16, 2018

Final docs might look like:

Option - 1

https://easyengine.io/docs/ <= a landing page, manually created using Gutenberg! ❤️🤘
https://easyengine.io/docs/commands/ <= auto-generated based on php docblocks
https://easyengine.io/docs/handbook/ <= auto-generated based on markdown files here
https://easyengine.io/docs/v3/ <= v3 docs will be moved here manually

docs itself will be a CPT in WordPress.

Option - 2

https://easyengine.io/docs/ <= a landing page, manually created using Gutenberg! ❤️🤘
https://easyengine.io/commands/ <= auto-generated based on php docblocks
https://easyengine.io//handbook/ <= auto-generated based on markdown files here

v3 docs will live at a current place for now.

/docs/ will be a normal page
/command/ and /handbook/ will be two CPTs in WordPress.

@rahul286 rahul286 added the programming Coding tasks related to docs automation label Nov 16, 2018
@rahul286
Copy link
Member Author

We are going with option-2 as it won't affect existing WP post/page

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
programming Coding tasks related to docs automation
Projects
None yet
Development

No branches or pull requests

1 participant