[Feature]: Unified repo and docs site documentation
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- backend-api-design, documentation
Research direction
Begin by finding the existing docs-site redirect implementation and any tests for library sources. Determine where a single source is represented, then define the multi-source behavior and verify that both repository and docs-site content can be attached to one library.
Written by the indexing model from the issue text.
Description
Problem Description
Many libraries, including mine, don't have all of their documentation available in the repo. Some of it is generated when publishing a docs site, or permanently lives on external sites.
While context7 does support redirecting to the docs site, sometimes there is information in the repository that is not in the docs site, and the repository is often much easier to parse.
Proposed Solution
Instead of forcing us to use either the docs site or the repository, it would be helpful if we could attach multiple sources (e.g. repo, docs site) to a single library.
Alternatives Considered
No response
Priority
Would improve my workflow
Additional Context
No response
- Dominant language
- TypeScript
- Stars
- 64.3k
- Forks
- 3.2k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 145
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from upstash/context7
-
good first issue help wanted
Difficulty 1/5 Under an hour Newbie friendliness 74/100
upstash/context7#339 · 98 comments · 7 reactions ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
Maintainers usually reply within 2 days
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
Maintainers usually reply within 2 days
-
[Feature]: Make proactive MCP instructions configurable and clarify reuse of resolved library IDsOpen
Difficulty 5/5 Over a week Newbie friendliness 35/100
upstash/context7#3219 · 1 comment ·
Maintainers usually reply within 2 days
-
Difficulty 5/5 Over a week Newbie friendliness 32/100
upstash/context7#2949 · 1 comment ·
Maintainers usually reply within 2 days
All issues in upstash/context7
Similar issues
-
area:ui
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
openfootmanager/openfootmanager#1365 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
good first issue priority: medium size: XS task
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 1 day
-
bug:unconfirmed
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Heroic-Games-Launcher/HeroicGamesLauncher#6062 ·
Maintainers usually reply within 1 day