opensafely / opensafely/documentation
Improve URL structure
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
URLs are typically based on the Markdown file names.
These are reasonably consistent, but don't really have much of a structure, and some URLs are not particularly descriptive.
We'd have to:
- Decide on what the URL structure would be
- Implement that URL structure
- Add redirects for the existing URLs to avoid breakage and preserve existing page SEO
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by deciding the URL structure, then identify where Markdown-derived URLs are generated and where existing-page redirects belong. Done means the new structure is implemented and existing URLs redirect without breakage or SEO loss.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100