2025-09-17 Docs WG Meeting notes

2025-09-17 Docs WG Meeting notes

All public Working Group meetings follow the Recording Policy for Open edX Meetings

 Date

Sep 17, 2025

 Participants

  • @Sarina Canelake

  • @Cassie Zamparini

  • @John Swope

  • @Peter Pinch

 Discussion topics

Time

Item

Presenter

Notes

Time

Item

Presenter

Notes

 

Review product marketing release notes

@Sarina Canelake

  • image-20250917-144259.png
    Proposed draft
  •  

  • See Draft pull request for clickable prototype



Core Contributor handbook migration

@Cassie Zamparini

[Discovery] Migrate and Add Relevant Content to Documentation

 

Release notes

@Peter Pinch

  • Linking to documentation from testing sheet for Ulmo

📰 Meeting Summary

The Documentors Working Group met to discuss improving Open edX documentation and release notes. Sarina presented a redesigned homepage concept featuring user-friendly "what's new" content in the left sidebar, aimed at making release notes more digestible compared to the current dense technical format. The team addressed technical issues with documentation tags causing build errors and navigation problems where clicking on release notes unexpectedly jumps users to different sections. The main focus was on migrating content from Confluence to the core contributor handbook, with Cassie leading the strategy to identify what content needs to move and John volunteering to help with the actual migration work once the strategy is defined.

 Action items

@Cassie Zamparini : Update the core contributor handbook document to outline what content needs migrating from Confluence, get team approval, and create GitHub issues for migration tasks
@Sarina Canelake : Investigate and fix the documentation duplication issue in the site operators section
@Sarina Canelake : File an upstream issue about the tags extension causing build errors - Hundreds of `document is referenced in multiple toctrees` warnings in my project · Issue #121 · melissawm/sphinx-tags
@Cassie Zamparini : Create a backlog ticket with screenshots documenting the confusing navigation jump issue for future work
@Peter Pinch : Create and host the testing coordination Google Doc, coordinating with Aamir about ownership preferences

 Decisions