Skip to content
This repository has been archived by the owner on Feb 9, 2021. It is now read-only.

Docs update #236

Merged
merged 4 commits into from Mar 6, 2018
Merged

Docs update #236

merged 4 commits into from Mar 6, 2018

Conversation

adam-james-v
Copy link
Collaborator

The changes:

  • re-organized the repo's readme somewhat so that the flow of information is a bit more consistent.
  • replaced parametricparts.com references with the mybinder Juptyer Notebook link.

NOTE: this is ONLY because from what I can tell parametricparts.com no longer serves as CQ execution environment. Jupyter notebooks with the cqnb module essentially replicate that idea though. If this is not ok, let me know!

  • very minor tweaks as I was reading through things.

What probably still needs some work:

  • the installation instructions page
  • I believe that we're cluttering up the readme with too many examples. I want to still encourage people to submit examples and we should showcase them somehow, but to continue putting them in the readme would be, perhaps, too much information in one spot. I think a 'community examples' repo might be a good solution, but am of course open to discusssion.

Thanks :)

Copy link
Owner

@dcowden dcowden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution, these look great.

I'm in agreement that we should lighten up the readme, and move examples out of the readme.

I'm not really in agreement that having them in a separate repo is great-- i think i'd ratther them be in contrib within our repo.

I'm struggling with whether community provide examples should be included in the automated builds. Right now i'm thinking 'no', but keeping them separate in contrib would let us add them in the future.

@adam-james-v
Copy link
Collaborator Author

I'm perfectly fine with a 'contrib' folder and not a whole new repo.
I agree that community examples should NOT be in the automated build.

@adam-james-v
Copy link
Collaborator Author

unrelated, is there a reason the coveralls check is still pending?
It seems to be taking a long time.

@dcowden
Copy link
Owner

dcowden commented Mar 6, 2018

Not sure what's going on-- some kind of delay with coveralls. I'll go ahead and merge.

@dcowden dcowden merged commit e572023 into master Mar 6, 2018
@coveralls
Copy link

Coverage Status

Coverage remained the same at 92.194% when pulling fd94c07 on docs_update into a229e1d on master.

@fragmuffin
Copy link
Contributor

Unrelated to this PR...
Is there a way to keep TravisCI's test environments persistent?
It seems wasteful to install everything from scratch every time a PR gets a commit.

@jmwright
Copy link
Collaborator

jmwright commented Mar 8, 2018

@fragmuffin I have not seen a way to do that.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants