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

Extend docs #130

Merged
merged 4 commits into from
Sep 12, 2018
Merged

Extend docs #130

merged 4 commits into from
Sep 12, 2018

Conversation

rgieseke
Copy link
Member

Pinging @znicholls
What else should we add here, more details on development/contributing probably?
As discussed in #129 and #116.

Fixes a Mkdocs deprecation warning as well.
@codecov-io
Copy link

codecov-io commented Sep 12, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #130   +/-   ##
=======================================
  Coverage   96.72%   96.72%           
=======================================
  Files           4        4           
  Lines         854      854           
  Branches      119      119           
=======================================
  Hits          826      826           
  Misses         16       16           
  Partials       12       12

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 f0de7e7...fdd210d. Read the comment docs.

@znicholls
Copy link
Collaborator

I think that's basically all of it. Once we have those you could then pick it up, look at the examples, read through contributing and developing and add something, completing the full pipeline?

@rgieseke
Copy link
Member Author

I've added a "Developing" section, not sure we need more than the "Contributing" currently in Readme, what do you think?

@znicholls
Copy link
Collaborator

not sure we need more than the "Contributing" currently in Readme, what do you think?

Also not sure we need it right now. I think the aim will be something like what we have in magicc or in scmcallib but doesn't need to be immediate

@rgieseke rgieseke changed the title WIP: Extend docs Extend docs Sep 12, 2018
@rgieseke
Copy link
Member Author

Alright ... if you're happy with the current state, we can merge.

@rgieseke
Copy link
Member Author

Would be good if we (=you) do the next release together and add anything that's missing/not working well.

@znicholls
Copy link
Collaborator

Would be good if we (=you) do the next release together and add anything that's missing/not working well

When do we want that release to be?

@rgieseke
Copy link
Member Author

When do we want that release to be?

Whenever you think we have enough meaningful changes ... io being renamed and ready should be worth a version bump.

@rgieseke rgieseke merged commit a212ce1 into master Sep 12, 2018
@rgieseke rgieseke deleted the extend-docs branch September 12, 2018 15:29
@rgieseke rgieseke mentioned this pull request Sep 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants