Skip to content

docs: Design the slices table converted into tabs #43

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
Open
asanvaq wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Design the slices table converted into tabs #43

asanvaq wants to merge 1 commit into from

Conversation

@asanvaq
Copy link
Contributor

@asanvaq asanvaq commented Dec 17, 2025 •
edited
Loading

The Design slices in docs/how-to/slice-a-package.md contains a table with uneven length cells. Due to different content amount, this is better suited for tabs. I have added them and removed the "Tip" feature, as the amount of text there was longer than in the body itself. It now is all part of the body.

This PR addresses issue #32 .

@asanvaq asanvaq requested a review from cjdcordeiro December 17, 2025 16:38
@cjdcordeiro
Copy link
Collaborator

cjdcordeiro commented Dec 17, 2025

This is a hard one. I intentionally used a table because

  1. the tabs are extremely easy to miss (in fact, I just did, when looking at the docs build)
  2. it creates the notion of a "default". Which I'd like to avoid. Both "schools of thought" are equally relevant, and I do not want people to default to whatever is the first tab
  3. it lacks boundaries...where does the tab's text end?

@asanvaq
Copy link
Contributor Author

asanvaq commented Dec 17, 2025

1&2. Makes sense, I will look for an alternative. The table had cells with very different sizes so I would prefer another option. I will update the PR after I've found something.

  1. There is a horizontal line at the bottom of the tab to mark where it ends.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cjdcordeiro cjdcordeiro Awaiting requested review from cjdcordeiro

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@asanvaq @cjdcordeiro