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

Move away from the monolithic README.md #102

Closed
melrief opened this issue Feb 1, 2017 · 4 comments · Fixed by #109
Closed

Move away from the monolithic README.md #102

melrief opened this issue Feb 1, 2017 · 4 comments · Fixed by #109
Assignees
Milestone

Comments

@melrief
Copy link
Collaborator

melrief commented Feb 1, 2017

No description provided.

@ruippeixotog
Copy link
Member

With our curent TOC, what do we want to move to the core module docs? There aren't includes in Markdown - that means some text will be a click away.

I was thinking of leaving the TOC as is and leave in the README all sections from "Why" to "Supported types" and from "Contribute" to "Special thanks". They provide the very basics for people to know what PureConfig is all about. All other sections can be accessed by the TOC, which links to other Markdown files.

@melrief, @jcazevedo, @leifwickland, do you agree?

@melrief
Copy link
Collaborator Author

melrief commented Feb 6, 2017

I agree

@jcazevedo
Copy link
Member

@melrief, @jcazevedo, @leifwickland, do you agree?

Yes.

@leifwickland
Copy link
Collaborator

shrug
My preference in the long term is that we let tut or another tool generate our ToC. I'm not entirely sure how that'll work out with that structure. But that's a bridge we can cross later.

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 a pull request may close this issue.

4 participants