readthedocs / readthedocs/ext-theme

Project: unify project version listing URLs/links

Open
#191 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

On the new dashboard, the project detail view is the project versions list. However, on the backend these are still separate as the views differ in production. The main difference is that the function view public.project_versions doesn't implement the same logic and filtered that exists on the detail page already.

The eventual goal should be:

  • ProjectDetailView becomes VersionListView
  • public.project_versions function view goes away
  • The ProjectDetailView URL basically goes away, and /project/slug/versions is the URL for the project dashboard. This is effectively the UX already, as the selected tab is the versions tab on the detail view page:

image

For now, all of the links could use the reverse lookup URL for project_version_list:

  • Project base template
  • Build detail and listing page
  • Version popupcard

Does this plan make sense? Does is seem okay to consolidate these views under /projects/slug/versions/?

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

Start by reviewing the Project base template, Build detail and listing page, Version popupcard, and the public.project_versions function view. Compare the existing detail-page logic with the versions listing and trace links that should use the project_version_list reverse lookup URL. Done means the consolidation plan is resolved and the affected links and views have an agreed target under /projects/slug/versions/.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.