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.

Sign up for GitHub

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

Jump to bottom

Find a better way to document "Unlisted" components #3

Closed
danoc opened this issue Jul 18, 2018 · 3 comments · Fixed by #610
Closed

Find a better way to document "Unlisted" components #3

danoc opened this issue Jul 18, 2018 · 3 comments · Fixed by #610

Comments

@danoc
Copy link
Member

danoc commented Jul 18, 2018

There are some "Unlisted" components such as ModalBase and UIAction that currently don't appear in the navigation. As @lavelle pointed out, it's sometimes necessary to access these components.

Instead of excluding the component from the navigation, we should include it and give it a different design treatment such a making the link light-gray, for example.

We should probably wait until the Thumbprint Guide documentation launches to do this since it includes a new visual design.
@danoc
Copy link
Member Author

danoc commented Aug 24, 2018

@tomgenoni — This would be a good thing to think about as your also think of the how we display deprecated packages.

@tomgenoni
Copy link

@danoc does this apply any longer?

@danoc danoc transferred this issue from another repository Jan 25, 2019
@danoc danoc mentioned this issue Mar 29, 2019
Closed
@danoc
Copy link
Member Author

danoc commented Mar 29, 2019

Yeah, let's just show them all for now and then clean up in the future. I can make the change.

@tomgenoni tomgenoni mentioned this issue May 6, 2019
Closed
@lavelle lavelle mentioned this issue Oct 17, 2019
Closed
danoc added a commit that referenced this issue Jan 7, 2020
@danoc
"Un-hide" the unlisted documentation pages
f81e818 
These were previously hidden because we wanted to discourage the use of them.

I think this is less necessary nowadays since:

* `body` and `reset` are now part of `global-css`. This allows us to delete those two pages since there's a single page for the `global-css` package.
* `ModalBase` and `ModalStandard` are deprecated
* Longread has been used in a few places in website.

In this PR I've:

* Deleted the `body` and `reset` pages, added redirects to the correct page.
* Added text and an example to longread.
* Fixed a link in the `ModalStandard` deprecation notice.
* Added a note to `ModalCurtain` that asks the developer to reach out to the Design Systems team before using the component.

We should explore remove `ModalBase` and `ModalStandard` as a follow-up task.

Fixes #3.
@danoc danoc mentioned this issue Jan 7, 2020
Merged
@danoc danoc closed this as completed in #610 Jan 8, 2020
danoc added a commit that referenced this issue Jan 8, 2020
@danoc
"Un-hide" the unlisted documentation pages (#610)
a1ef2ea 
These were previously hidden because we wanted to discourage the use of them.

I think this is less necessary nowadays since:

* `body` and `reset` are now part of `global-css`. This allows us to delete those two pages since there's a single page for the `global-css` package.
* `ModalBase` and `ModalStandard` are deprecated
* Longread has been used in a few places in website.

In this PR I've:

* Deleted the `body` and `reset` pages, added redirects to the correct page.
* Added text and an example to longread.
* Fixed a link in the `ModalStandard` deprecation notice.
* Added a note to `ModalCurtain` that asks the developer to reach out to the Design Systems team before using the component.

We should explore remove `ModalBase` and `ModalStandard` as a follow-up task.

Fixes #3.
danoc added a commit that referenced this issue Jan 11, 2023
@danoc
Next.js #3: Set up the beginnings of the /atomic pages (#872)
61bb6fa 
This takes the functionality that was previously part of the Gatsby
transformer and it moves it into the Atomic getStaticProps.

This includes only the Aspect Ratio content for the Atomic docs.
The rest will come later.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

"Un-hide" the unlisted documentation pages thumbtack/thumbprint
2 participants
@danoc @tomgenoni