readthedocs / readthedocs/ext-theme
Projects: custom avatar improvements
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 12
- Forks
- 6
- Avg merge
- 13h 25m
- Merged PRs (30d)
- 1
Description
Right now, projects disconnected from a remote repo get a generated avatar and projects connected through a remote repo get the social account avatar. Most of the time the remote repo avatars look great, especially if repositories have differing owners, but it can lead to redundant avatars.
A couple improvements here:
- GitLab supports project avatars, we can use these if we aren't already
- GitHub doesn't but support repo avatars but does have repo "social preview" images. I don't know if these images are in the existing API response or not, or only usable with an HTTP request
- We could follow #94 and just allow manual project avatars too
Contributor guide
No contributing guide indexed for this repository
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 does not name files or tests. Start by tracing how disconnected and remote-connected projects currently select avatars, then check whether GitLab project avatars or GitHub social-preview images are present in the existing API response. Done means implementing an agreed avatar source or manual-avatar path with the redundant-avatar behavior resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, gitlab
- Domain
- frontend, web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100