Skip to content

docs: tighten the ribbon guidelines into lasting rules - #904

Merged
deniial00 merged 1 commit into
opengeos:update-docs-ribbon-guidelinesfrom
Mavrick-F:docs/ribbon-guidelines-review
Oct 25, 2026
Merged

deniial00 merged 1 commit into
opengeos:update-docs-ribbon-guidelinesfrom
Mavrick-F:docs/ribbon-guidelines-review

Conversation

@Mavrick-F

Copy link
Copy Markdown
Member

Summary

Follow-up to #903, stacked on its branch. It keeps the guidelines and tab purposes from #862, and makes them rules that won't go stale as those decisions land:

  • Rules, not decisions. Drops the contributor credit, the Directions exception and the Go To XY ruling. Interim exceptions are recorded in the issue that tracks the move.
  • Labels say what happens (rule 10 in the draft rule book) is added, with Go To XY as its example.
  • Checklist by change size. Adding a control states its task, tab, how it opens and a screenshot. Moving, removing or regrouping controls also states the remaining route and the before/after workflow counts.
  • 1366 px replaces "laptop width", so the width check can be repeated.
  • Layer chooser is marked as planned, so it doesn't block the next Style PR.
  • Split-button example is now Select, which is a split button today; Add Data isn't yet.
  • AGENTS.md points to the guidelines, since many PRs here are written by agents.

Documentation only; no ribbon controls, command ids or parameters change.

Testing

  • zensical build: no issues found.
  • SKIP=cargo-fmt,cargo-clippy pre-commit run on the changed files: passed.
  • cargo xtask ci was not run: only Markdown changed, so its fmt, clippy, test and layer checks have nothing new to check. CI on this PR runs them.

Related issue

Stacked on #903; follows discussion #862.

🤖 Generated with Claude Code

- State rules rather than one-off decisions from opengeos#862: drop the
  contributor credit, the Directions exception and the Go To XY ruling;
  interim exceptions are recorded in the issue that tracks the move.
- Add "labels say what happens", with Go To XY as its example.
- Split the PR checklist: adding a control needs its task, tab, how it
  opens and a screenshot; moves and removals also need the remaining
  route and the workflow comparison.
- Check width at 1366 px instead of "laptop width".
- Mark the layer chooser as planned.
- Use Select, which is a split button today, as the split-button example.
- Point AGENTS.md at the guidelines.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 25, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 3b48a286-0880-4d62-b658-b238d2cc3198

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

Code review

This PR only changes documentation: AGENTS.md and docs/contributing.md. I found no bugs, security issues or performance problems, and I posted no inline comments.

What I checked

  • Anchors: #documentation resolves to the ## Documentation heading at line 151 of contributing.md. The architecture.md#everything-is-a-command link resolves to the heading at line 21 of architecture.md. The new AGENTS.md link to docs/contributing.md#ribbon-guidelines matches the heading at line 43.
  • Consistency: the rewritten guidelines hold together. The PR template is split into "adds" and "moves, removes or regroups", and the 1366 px width is used consistently. The new "Labels say what happens" rule and the Select split-button example are consistent with the surrounding text.
  • AGENTS.md: the new "Ribbon placement" bullet is short and fits the existing style. The PR removes the discussion How should the ribbon be organised? A look at what's there today #862 attributions and some control-specific examples from contributing.md. That fits its stated aim of keeping lasting rules only.

Bugs

None found.

Security

None found.

Performance

Not applicable.

Quality

  • Low confidence, a nit: the PR removes the rule that the name Go To XY is kept for the coordinates-only dialog. The new "Labels say what happens" bullet still gives Go To XY as an example, so the rule survives in spirit.

AGENTS.md

No violations. The PR adds no code, assets or dependencies, and the quality gates for code don't apply.

Change size

Compared: the whole PR against update-docs-ribbon-guidelines (merge base 7d6b909 to PR head 0539278)

Metric Value
Files changed 2 (added 0, modified 2, removed 0, renamed 0)
Size before 16.9 KB
Size after 16.9 KB
Total size change -60 B
File Before After Change
docs/contributing.md 11.1 KB 10.8 KB -276 B
AGENTS.md 5.9 KB 6.1 KB +216 B

@deniial00
deniial00 merged commit dbb4759 into opengeos:update-docs-ribbon-guidelines Oct 25, 2026
7 checks passed
giswqs pushed a commit that referenced this pull request Oct 25, 2026
* docs: define ribbon design and contribution guidelines

* docs: tighten the ribbon guidelines into lasting rules (#904)

---------

Co-authored-by: Mavrick Fitzgerald <MavrickFitzgerald@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants