CONTENT: documentation text and styles #6
Conversation
|
|
||
| ## Other recommendations | ||
| ### Python version support | ||
| You should always be explicit about which versions of Python your package supports. |
There was a problem hiding this comment.
This should be in the package structure section MOVE...
There was a problem hiding this comment.
This is all commented out. i didn't want to lose text so i commented it as i'm reorganizing it all...
| A good rule of thumb is that the package should support, at least, | ||
| the latest three Python versions (e.g., 3.8, 3.7, 3.6). | ||
|
|
||
| ### Code Style |
There was a problem hiding this comment.
This belongs in the code style section
|
Ok this is ready for a review if anyone wants to review. I'll leave it open for 4 days with the goal of merging it next wednesday November 2. the pr is failing because the circle ci config file isn't in this pr yet. i'm still getting dup builds on merge and pull and would love to fix that but my fix didn't work. |
| color: #1abc9c; | ||
| } | ||
|
|
||
| @media (min-width: 720px){ |
There was a problem hiding this comment.
TODO for another PR - clean up this mess of CSS. hey that rhymed. i'm a poet and didn't know it. Till i made a mess of the CSS.
oops. i did it again.
| @@ -0,0 +1,7 @@ | |||
| <!-- custom head content--> | |||
There was a problem hiding this comment.
This needs to go bye bye cause it don't work. i thought it was to modify the but instead it modifies the HTML header on the page not the head code. boo.
documentation/create-readme-files.md
Outdated
| @@ -0,0 +1,176 @@ | |||
| # README File Guidelines and Resources | |||
|
|
|||
| https://devguide.ropensci.org/building.html#readme | |||
There was a problem hiding this comment.
oops will comment this out! all of my github tools disappeared today so i can't do it here? ?como?
|
|
||
| Please go through this list before submitting your package to pyOpenSci | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Eventually will be an include file so it can be ported elsewhere if need be.
| as you release updates. | ||
|
|
||
|
|
||
| ## API documentation |
There was a problem hiding this comment.
This is just a start - this file isn't at all done yet so please focus review on the readme for now. but anyone is welcome to read what is here now too.. just know it's just a start.
index.md
Outdated
| @@ -126,4 +146,101 @@ Removing button for the time being | |||
| Get Involved (Maybe a link to a get involved page) | |||
| ``` --> | |||
|
|
|||
| <!-- | |||
There was a problem hiding this comment.
This is all commented out. i need to make sure it's all in the readme file but you can ignore this as it won't render on the page.
|
Merging this and then moving to a fork for other pr's!!! |
This contains only the content for documentation and style updates
Will support faster updating!
Files to Remove
Cleanup Items