Conversation

zephaniahong

Created a general template for future API documentation, tutorials, etc...

@zephaniahongzephaniahong linked an issue Aug 21, 2022that may be closed by this pull request
@zephaniahongzephaniahong marked this pull request as ready for review August 21, 2022 10:31
@John15321

I have an important thing at work tomorrow and a few job interviews on Tue. So I'm probably gonna check this out on Wed, sorry for delay. Also you can add a actions ci job in the same PR if you want

@zephaniahong

No worries! All the best(:
Could I clarify what the CI job would/should do?
Are you referring to something like this: https://.com/marketplace/actions/mdbook-action#getting-started?

@John15321

No worries! All the best(:
Could I clarify what the CI job would/should do?
Are you referring to something like this: https://.com/marketplace/actions/mdbook-action#getting-started?

I'm talking about creating a Actions CI job that triggers when someone pushes to develop and hosts the mdbook using io

@zephaniahongzephaniahong removed the request for review from John15321 August 22, 2022 12:40
@zephaniahongzephaniahong marked this pull request as draft August 22, 2022 12:41
@zephaniahongzephaniahong self-assigned this Aug 22, 2022
@dawnofmidnight

Quick suggestion: you should probably add guide/book to the gitignore, since you don't want to push all the built artifacts to version control every time.

@zephaniahong

Quick suggestion: you should probably add guide/book to the gitignore, since you don't want to push all the built artifacts to version control every time.

Hey @dawnofmidnight! Correct me if I'm wrong but won't that mean no one else would have a copy of the book?

@dawnofmidnight

Quick suggestion: you should probably add guide/book to the gitignore, since you don't want to push all the built artifacts to version control every time.

Hey @dawnofmidnight! Correct me if I'm wrong but won't that mean no one else would have a copy of the book?

The typical workflow for mdbook is for your to only commit the source (markdown) files to git. People should build their own html version locally.

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

Successfully merging this pull request may close these issues.

Create project documentation in markdown using mdbook