readthedocs / readthedocs/ext-theme

Make organization navigation item conditional

Open
#332 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Needed: design decision
Dominant language
HTML
Stars
12
Forks
6
Avg merge
13h 25m
Merged PRs (30d)
1

Description

Moved from

  • #299

I made an attempt at this and had success, but the additional logic slowed down all views considerably. I used the organizations template filters to try to get a list of user organizations. This might need some more thought, and perhaps we do this in the UX side of things instead of using display time logic -- using the organization selection workflow or something?

This is working for now though, it's just very explicit for most users that only need one organization.


  • When there is only one organization, the menu item should be "Organization" and lead to the detail view for the only org
  • When there are more than one organization, go to the listing view
  • If the user does not have an organization, perhaps also go to the listing view? This might be the best place to show organization creation onboarding?

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Review the existing organization navigation templates and the prior attempt referenced from #299, especially the organizations template filters and their view-time cost. Decide where the organization-count check belongs, then verify the menu destination for zero, one, and multiple organizations without slowing other views.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.