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

Core-packages pages #1026

Closed
wants to merge 7 commits into from
Closed

Core-packages pages #1026

wants to merge 7 commits into from

Conversation

xtuc
Copy link
Member

@xtuc xtuc commented Dec 2, 2016

Refers to #1021.

Index page:
core-packages-d1

@hzoo The index page could replace usage > API (https://babeljs.io/docs/usage/api/). We can then move the doc in babel-core (https://github.com/babel/babel/blob/master/packages/babel-core/README.md).

usage > babel-register (https://babeljs.io/docs/usage/babel-register/) same problem.

@xtuc xtuc added the docs label Dec 2, 2016
@xtuc xtuc mentioned this pull request Dec 2, 2016
10 tasks
@xtuc
Copy link
Member Author

xtuc commented Dec 3, 2016

@hzoo @existentialism What are your thought about this ? I will then move/link some pages from babel/babel.github.io to babel/babel.


## Other packages

* [Types](types): Babel Types is a Lodash-esque utility library for AST nodes
Copy link
Member

Choose a reason for hiding this comment

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

we can call it the package name if it's better - and does that link work?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is a relative link (points to docs/core-packages/types).

Copy link
Member

Choose a reason for hiding this comment

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

Do you think it should be babel-types or types

Copy link
Member Author

Choose a reason for hiding this comment

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

I did prefix all package in c9a8804

@existentialism
Copy link
Member

existentialism commented Dec 3, 2016

Might not need to solve this now, but some things to think about as we establish more consistency across docs:

  • Title case for titles?
  • Perhaps super nitpicky, but it's semi strange to have an h2 (Core) followed by another h2 (Install)

Otherwise LGTM, nice work!

@hzoo
Copy link
Member

hzoo commented Dec 3, 2016

Docs have a lot of inconsistency yeah - kinda wish we could lint (I know there's a few markdown linters)

@xtuc
Copy link
Member Author

xtuc commented Dec 3, 2016

It would be great to lint babel/babel/packages/*/README.md.

@hzoo
Copy link
Member

hzoo commented Dec 3, 2016

yeah with a markdown AST plus custom rules 😛

I know there's https://github.com/textlint/textlint by @azu but I haven't checked it out that much

@xtuc
Copy link
Member Author

xtuc commented Dec 6, 2016

  • /docs/usage/api is now babel-coreREADME (ef667bb)
  • /docs/usage/babel-register is now babel-register README (9fbb62b)

@existentialism @hzoo @mareksuscak

@xtuc xtuc removed the do-not-merge label Dec 6, 2016
@xtuc xtuc force-pushed the feat-core-package-index branch from 240bf3c to 17d6e5f Compare December 6, 2016 19:29
@xtuc xtuc force-pushed the feat-core-package-index branch from 17d6e5f to fee6181 Compare December 6, 2016 19:34
@hzoo
Copy link
Member

hzoo commented Dec 6, 2016

Merging in #1044

@hzoo hzoo closed this Dec 6, 2016
@xtuc xtuc deleted the feat-core-package-index branch December 6, 2016 19:48
@xtuc xtuc mentioned this pull request Dec 8, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants