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

create an mdbook for documentation #427

Merged
merged 3 commits into from Aug 15, 2019

Conversation

@efx
Copy link
Contributor

efx commented Aug 10, 2019

Start to resolve #62 and other documentation related issues.

I found this this rust subreddit discussion about best practices for documentation. Doxidize seems like it could suit us well but isn't ready for use.
mdBook may not integrate as nicely with a crate but it seems like the community standard.
I started a preliminary structure but am sure we should establish the audience and then establish a suitable TOC.

efx added 3 commits Aug 8, 2019
Start to resolve #62 and other documentation related issues.
@codecov

This comment has been minimized.

Copy link

codecov bot commented Aug 10, 2019

Codecov Report

Merging #427 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master    #427   +/-   ##
======================================
  Coverage    43.7%   43.7%           
======================================
  Files         136     136           
  Lines       59536   59536           
======================================
  Hits        26019   26019           
  Misses      33517   33517

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d66969b...a947c7c. Read the comment docs.

@pkgw

This comment has been minimized.

Copy link
Collaborator

pkgw commented Aug 15, 2019

Thank you for the submission, and sorry for the delay in my getting to this! Let's get things rolling!

@pkgw pkgw merged commit 32081c8 into tectonic-typesetting:master Aug 15, 2019
2 checks passed
2 checks passed
ci/circleci Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
@efx

This comment has been minimized.

Copy link
Contributor Author

efx commented Aug 15, 2019

No need to apologize @pkgw! 🚀

@efx efx deleted the efx:topic-documentation branch Aug 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

2 participants
You can’t perform that action at this time.