dfinity / dfinity/developer-docs
infra: content gap analysis
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- JavaScript
- Stars
- 4
- Forks
- 5
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 30
Description
Context
After the content migration sprints, a systematic comparison of all upstream sources against written docs is needed to find what's missing or outdated.
Steps
- List all portal source pages in
.sources/portal/docs/ - Map each to its corresponding page in
docs/(usemigration-plan.mdas a starting point) - For pages that exist in portal but not in docs: evaluate if they belong (some portal content is not relevant for the rewrite)
- For pages that exist in docs: spot-check for staleness against
.sources/upstream content - File individual issues for any meaningful gaps discovered
- Update
.docs-plan/migration-plan.mdwith gap findings
Output
A structured report in .docs-plan/ (or as a GitHub issue comment) listing gaps and their priority.
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
Start with the portal source pages in .sources/portal/docs/, the existing docs/ tree, and .docs-plan/migration-plan.md. Map source pages to documentation pages, assess relevance and staleness, then record prioritized gaps in a structured report under .docs-plan/ or an issue comment. Done means meaningful gaps are documented and individual issues are filed for them.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100