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

Readme tweaks #54

Merged
merged 3 commits into from Jan 4, 2016

Conversation

@AdrieanKhisbe
Copy link
Contributor

AdrieanKhisbe commented Jan 2, 2016

Extract Api.md so it would be more easy to include it with hapijs.com plugin pages.

@cjihrig

This comment has been minimized.

Copy link
Contributor

cjihrig commented Jan 3, 2016

Does this need a <!-- tocstop --> like the joi document uses?

@AdrieanKhisbe

This comment has been minimized.

Copy link
Contributor Author

AdrieanKhisbe commented Jan 3, 2016

@cjihrig

This comment has been minimized.

Copy link
Contributor

cjihrig commented Jan 3, 2016

I have no opinion. I hate the API.md idea. So, whatever makes it work properly is fine with me.

@Marsup

This comment has been minimized.

Copy link
Member

Marsup commented Jan 3, 2016

Toc generation is independent from the API.md decision, though it has helped me a lot consistently getting the toc right and avoiding useless PRs. Your choice.

@AdrieanKhisbe

This comment has been minimized.

Copy link
Contributor Author

AdrieanKhisbe commented Jan 3, 2016

I added then the toc generation from joi.

cjihrig added a commit that referenced this pull request Jan 4, 2016
Readme tweaks
@cjihrig cjihrig merged commit b4702e2 into hapijs:master Jan 4, 2016
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@@ -16,11 +16,14 @@
"hoek": "3.x.x"
},
"devDependencies": {
"lab": "7.x.x"
"lab": "8.x.x",
"markdown-toc": "^0.12.3"

This comment has been minimized.

Copy link
@Marsup

Marsup Jan 4, 2016

Member

Can't guarantee it'll keep working with a 0.x version, this should be made sticky to 0.12 as joi did.

This comment has been minimized.

Copy link
@AdrieanKhisbe

AdrieanKhisbe Jan 4, 2016

Author Contributor

you mean keep lab 7?

This comment has been minimized.

Copy link
@cjihrig

cjihrig Jan 4, 2016

Contributor

No, markdown-toc. Semver doesn't really apply the same way prior to v1.x.x. Can you drop the ^

This comment has been minimized.

Copy link
@AdrieanKhisbe

AdrieanKhisbe Jan 4, 2016

Author Contributor

okey dokey.
Didn't know about that.

Shall I made a dedicated PR?

This comment has been minimized.

Copy link
@cjihrig

cjihrig Jan 4, 2016

Contributor

Yes please.

This comment has been minimized.

Copy link
@AdrieanKhisbe

AdrieanKhisbe Jan 4, 2016

Author Contributor

voilà: #55

@cjihrig cjihrig added this to the 2.1.1 milestone Jan 4, 2016
@cjihrig cjihrig self-assigned this Jan 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.