Docs #64
Docs #64
Conversation
CONTRIBUTING.rst
Outdated
| How To Contribute | ||
| ================= | ||
|
|
||
| First off, thank you for considering contributing to ``attrs``! |
There was a problem hiding this comment.
This should probably refer to Numismatic
There was a problem hiding this comment.
Yes, if you look closely, you may even find more mistakes. I will fix this all up on Sat (Sat I am devoting my whole day to this). However, we should chat quickly first. I need help on three things from you:
- The roadmap - I would like to give you my input to this, but I think since you are the lead on this project, you should... um, take the lead :) So lets chat about this
- The CLI - it would really help if you did this.
- Changelog - you are in a unique position to make this coherent.
Everything else I can do, from the philosophy of the project, to the explaining of the architecture, and the examples of extending. Of course, you will be able to check all this and make edits.
|
Thank you for setting up all this docs infrastructure @barrysteyn . Once this is merged, please submit what you started writing, maybe in a separate PR. |
|
I expect that we only merge it once we are finished with the documentation. Do you have other ideas? |
|
No, I think let's merge the basic skeleton. That way, as we fix other parts etc... one can update the docs at the same time. |
|
Okay, fair enough, but then let me remove the attr references that are in
the documents
…On Dec 6, 2017 7:36 AM, "Tobias Brandt" ***@***.***> wrote:
No, I think let's merge the basic skeleton. That way, as we fix other
parts etc... one can update the docs at the same time.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#64 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/ABd1RBAShP3l9mEJbIqpEQIik3rEIOIyks5s9rSUgaJpZM4Q2nR4>
.
|
|
I think we should merge this now... |
Docs PR. You will need to install Sphinx. Then it's easy: go to docs folder, and
make html. The resulting html documents are in the build folder. However, you will need to work on the rst files in the source folder.I have copied quite a bit of things, and spent sometime writing. But then I threw most of it away :( I have come to the conclusion that it is probably better if we coordinate this more... for instance, I think we agree on the design goals (and so I left them be), but on other things I am not so sure.
Lets start communicating via whatsapp