Stop calling a seeded connection's group a sidebar label in the docs

Closed Beginner friendly
  • Is something wrong?
#2,157 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Start by running the grep in the issue to list every 'Group label in sidebar' and 'group still shows' occurrence. The edits are wording changes at docs/SEED_CONNECTIONS.md lines 200, 394 and 1293, README.md:1022, README_ko.md:976, README_zh.md:953, and one code comment at src/lib/seed/kubernetes-discovery-contract.ts:466. Done when the grep returns nothing, the group rows in all READMEs match, and bun run readme:check passes. The issue also says the PR should delete the DOC14 entry in docs/BACKLOG.md.

Written by the indexing model from the issue text.

Description

documentation good first issue

What

The seed reference and the READMEs say a seeded connection's group is a label shown in the sidebar. Nothing in the UI reads a connection's group: the seed loader copies it onto the connection and it is stored, but the sidebar's groups are the ones a user creates, kept by src/hooks/use-connection-groups.ts. Whether the UI should show the seeded value is a separate product decision; this issue only fixes the docs.

Where

docs/SEED_CONNECTIONS.md:200:

group: "Data Team" # Group label in sidebar

docs/SEED_CONNECTIONS.md:394 (the field table row):

| connections[].group | No |

| Group label |

docs/SEED_CONNECTIONS.md:1293 (Kubernetes discovery):

and the group still shows the namespace whole;

README.md:1022:

| connections[].group | No | Group label in sidebar |

README_ko.md:976:

Sidebar에 표시되는 그룹 label

README_zh.md:953:

侧边栏里的分组标签

Where the value goes in the code:

  • src/lib/seed/types.ts:174 validates it: group: z.string().max(64).optional(),
  • src/lib/seed/connection-filter.ts:76 copies it: group: conn.group,
  • src/lib/governance/admission.ts:236 writes it: ...present("group", row.group_name),

Expected

The docs say group is validated (a string of at most 64 characters) and stored with the connection, and that the sidebar does not show it.

How to fix

  1. docs/SEED_CONNECTIONS.md:200: change the comment to something like # Stored with the connection; not shown in the sidebar.
  2. docs/SEED_CONNECTIONS.md:394: change the description cell to say the value is validated (at most 64 characters) and stored, and not shown in the sidebar.
  3. docs/SEED_CONNECTIONS.md:1293: change "the group still shows the namespace whole" to "the group still holds the namespace whole". Make the same change in the code comment at src/lib/seed/kubernetes-discovery-contract.ts:466 ("the connection's group shows the namespace whole").
  4. README.md:1022: change "Group label in sidebar" to the same wording as step 2.
  5. Make the same change in the matching rows of README_ko.md:976 and README_zh.md:953.

How to check

grep -n "Group label in sidebar\|group still shows" docs/SEED_CONNECTIONS.md README.md   # no output
grep -n "connections\[\].group" README.md README_ko.md README_zh.md docs/SEED_CONNECTIONS.md
bun run readme:check

Backlog

This is entry DOC14 in docs/BACKLOG.md. The PR that fixes it deletes that entry.

Dominant language
TypeScript
Stars
810
Forks
158
Avg merge
9h 48m
Merged PRs (30d)
627

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from libredb/libredb-studio

All issues in libredb/libredb-studio

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.