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

feat(docs): planetar component descriptions & rethink naming [1h] #21

Open
3 tasks
mesqueeb opened this issue Sep 9, 2020 · 0 comments
Open
3 tasks
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mesqueeb
Copy link
Member

mesqueeb commented Sep 9, 2020

Prerequisite

#19

Goal

  • write a short component description for each component in a JSDoc above the export default section

  • rename ApiComponentExample to ApiCardInteractive

  • renameMarkdownSection and CodeBlockSection to something else:

So we have some components which end in ...Section because they are to be used as a documentation "section", which incorporate whatever ... stands for with an extra section of some text?

This makes sense.

However, MarkdownSection and CodeBlockSection are a bit different as they just allow the use of a filePath as opposed to Markdown and CodeBlock.
Things to think about:

is it really necessary to separate Markdown and CodeBlock with their counterparts that can accept a filePath?

I believe so because projects not relying on webpack that still want to use Markdown might have problems when the webpack related code is included. But we need to rename Section to something else.

@mesqueeb mesqueeb changed the title feat(docs): planetar component descriptions & rethink naming feat(docs): planetar component descriptions & rethink naming [1h] Sep 9, 2020
@mesqueeb mesqueeb added this to the release milestone Oct 16, 2020
@mesqueeb mesqueeb added the documentation Improvements or additions to documentation label Oct 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant