-
-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
DocsAddressing VC docsAddressing VC docsUp for GrabsAvailable for a contributorAvailable for a contributor
Description
Description
Many documentation pages reference related processes or information but don't include helpful links to those resources. Adding proper cross-references will improve discoverability and help volunteers navigate between related topics.
Areas Needing Cross-References
- Role descriptions → Link to relevant process documentation
- Process docs → Link to related roles and responsibilities
- Monthly challenges → Cross-link similar challenges and general guidelines
- Event documentation → Link between planning, execution, and post-event processes
- Coffee Table Groups → Link between host guides, coordinator info, and specific group guides
Specific Examples
- Lightning Talks speaker guide should link to mentor guide and MC script
- Lunch & Learn roles should cross-reference each other
- Monthly challenge READMEs should link to facilitator handbook
- Coffee host documentation should reference room leader and MC guides
- A/V documentation should link between streaming, YouTube, and post-production
Implementation Tasks
- Audit existing documentation for missing internal links
- Create a site map/relationship diagram of all documentation
- Add "Related Documentation" sections where appropriate
- Use Docusaurus admonitions for helpful cross-references
- Add "See also" sections at the end of major documents
- Create index pages that serve as navigation hubs for major topics
Acceptance Criteria
- Related documents are properly cross-linked
- Navigation between topics is intuitive
- No dead ends where volunteers can't find next steps
- Index/hub pages created for major topic areas
- Internal link structure documented for maintenance
This will significantly improve the user experience for volunteers trying to understand their roles and responsibilities!
Metadata
Metadata
Assignees
Labels
DocsAddressing VC docsAddressing VC docsUp for GrabsAvailable for a contributorAvailable for a contributor