2026-05-20 Meeting Notes for Documentation Working Group

2026-05-20 Meeting Notes for Documentation Working Group

 Date

May 20, 2026, next meeting Jun 3, 2026

Recording (22 minutes)

LF anti-trust policy notice.png

 Participants

  • @Joe Pearson

  • @EUGENE O'CONNOR

 Followup

  • In progress: Review AIO installation instructions

  • In progress: Review Agent installation instructions (dependency on Gather edge node files)

  • Completed: Docs sync w/downstream -- issue 682

    • Open new issues for each item

  • In progress: New page(s) based on Nathan’s email

 Brainstorm

 Discussion topics

Time

Topic

Presenter

Notes

Time

Topic

Presenter

Notes

 

TOC re-ordering

 

  • Where do we stand and what’s next?

  • Anything we need to do for TechEx/Edge Computing Expo?

  • Issue 708

 

anax repo E2E testing short-circuit when merging docs

 

  • Lily is working on PR 4488 +:

    • Notified yesterday that the process is still triggering a build

    • May also want an exception for commits with only .github changes.

  • Is this fixed? Yes, also 4489.

 

Enhance docs

@Joe Pearson

Documentation README does not have a section covering pre-requisites and first time setup. Opened issue 711 to address.

 

Re-write README?

@Joe Pearson

Minimal README + link out to detailed docs
Best if you want the README to serve as a concise gateway.

Changes
- Keep only:
- project contribution overview
- how to find issues
- basic fork/branch/test/PR flow
- links to full contributor docs
- Remove most step-by-step duplication
- Treat the README as an entry page, not full contributor training

Pros
- Very scannable
- Lowest long-term maintenance
- Strong for discoverability and onboarding

Cons
- Less self-contained
- Users must follow links for detail

Best for
- Repositories that already have strong contributor docs elsewhere

 Action items

Add content sections for using 3rd party solutions like ModelArmor and EdgeLake
Administering/Administering functions
Installing OH vs All-in-One

 Decisions

 Related info