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
Merged

Conversation

AdrieanKhisbe
Copy link
Contributor

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

@cjihrig
Copy link
Contributor

cjihrig commented Jan 3, 2016

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

@AdrieanKhisbe
Copy link
Contributor Author

AdrieanKhisbe commented Jan 3, 2016 via email

@cjihrig
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
Copy link
Contributor

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
Copy link
Contributor Author

I added then the toc generation from joi.

cjihrig added a commit that referenced this pull request Jan 4, 2016
@cjihrig cjihrig merged commit b4702e2 into hapijs:master Jan 4, 2016
@@ -16,11 +16,14 @@
"hoek": "3.x.x"
},
"devDependencies": {
"lab": "7.x.x"
"lab": "8.x.x",
"markdown-toc": "^0.12.3"
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you mean keep lab 7?

Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okey dokey.
Didn't know about that.

Shall I made a dedicated PR?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes please.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

voilà: #55

@cjihrig cjihrig added the documentation Non-code related changes label Jan 4, 2016
@cjihrig cjihrig added this to the 2.1.1 milestone Jan 4, 2016
@cjihrig cjihrig self-assigned this Jan 4, 2016
@lock
Copy link

lock bot commented Jan 9, 2020

This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions.

@lock lock bot locked as resolved and limited conversation to collaborators Jan 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Non-code related changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants