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

Docs #64

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Docs #64

wants to merge 6 commits into from

Conversation

barrysteyn
Copy link
Contributor

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

CONTRIBUTING.rst Outdated
How To Contribute
=================

First off, thank you for considering contributing to ``attrs``!
Copy link
Owner

Choose a reason for hiding this comment

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

This should probably refer to Numismatic

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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:

  1. 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
  2. The CLI - it would really help if you did this.
  3. 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.

@snth
Copy link
Owner

snth commented Dec 6, 2017

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.

@barrysteyn
Copy link
Contributor Author

I expect that we only merge it once we are finished with the documentation. Do you have other ideas?

@snth
Copy link
Owner

snth commented Dec 6, 2017

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.

@barrysteyn
Copy link
Contributor Author

barrysteyn commented Dec 6, 2017 via email

@barrysteyn
Copy link
Contributor Author

I think we should merge this now...

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.

2 participants