actions/update-docs
actions/update-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: review documentation (2026-03-10) #1

New issue
Closed
opened 2026-03-10 15:47:39 -07:00 by forgejo-actions · 2 comments
forgejo-actions commented 2026-03-10 15:47:39 -07:00
Copy link

@intern — Recent changes have been pushed to this repository. Please review the following documentation and update if needed.

Files to Review

  • README.md

Recent Changes (since 2026-03-10)

Commits:
72e0826 ci: dog food our own action

Changed files:
.forgejo/workflows/update-docs.yml

Instructions

  1. Review each documentation file against the recent changes
  2. Check for: outdated instructions, missing features, incorrect examples, broken references
  3. If updates are needed, commit and push your changes directly to the main branch. Then close this issue with a comment summarizing what you changed.
  4. If documentation is current: comment explaining no changes needed
@intern — Recent changes have been pushed to this repository. Please review the following documentation and update if needed. ### Files to Review - `README.md` ### Recent Changes (since 2026-03-10) **Commits:** 72e0826 ci: dog food our own action **Changed files:** .forgejo/workflows/update-docs.yml ### Instructions 1. Review each documentation file against the recent changes 2. Check for: outdated instructions, missing features, incorrect examples, broken references 3. If updates are needed, commit and push your changes directly to the `main` branch. Then close this issue with a comment summarizing what you changed. 4. If documentation is current: comment explaining no changes needed
intern was assigned by forgejo-actions 2026-03-10 15:47:39 -07:00
intern commented 2026-03-10 15:48:25 -07:00
Collaborator
Copy link

Review Summary

Reviewed README.md against commit 72e0826 (ci: dog food our own action).

Change: Added .forgejo/workflows/update-docs.yml — the repo now uses its own action.

Finding: README is mostly accurate but missing a real-world example reference. The repo itself is now a live example of the action in use, but this isn't mentioned in the docs.

Proposed update:
Add a "Real-World Example" section referencing .forgejo/workflows/update-docs.yml to show users how this repo uses the action on itself.

Committing update now.

## Review Summary Reviewed README.md against commit 72e0826 (ci: dog food our own action). **Change:** Added `.forgejo/workflows/update-docs.yml` — the repo now uses its own action. **Finding:** README is mostly accurate but missing a real-world example reference. The repo itself is now a live example of the action in use, but this isn't mentioned in the docs. **Proposed update:** Add a "Real-World Example" section referencing `.forgejo/workflows/update-docs.yml` to show users how this repo uses the action on itself. Committing update now.
intern commented 2026-03-10 15:49:16 -07:00
Collaborator
Copy link

Resolution

Commit: 147a77b

Changes made:

  • Added "Real-World Example" section to README.md
  • Links to the repo's own workflow as a working reference
  • Highlights key configuration choices (direct push vs PR, triggers, defaults)

Rationale:
The recent dogfooding commit (72e0826) made this repo a live example of the action in use. Users benefit from seeing a real implementation, not just example snippets. The new section provides context and encourages copy-paste adaptation.

Closing issue — documentation is now up to date.

## Resolution **Commit:** 147a77b **Changes made:** - Added "Real-World Example" section to README.md - Links to the repo's own workflow as a working reference - Highlights key configuration choices (direct push vs PR, triggers, defaults) **Rationale:** The recent dogfooding commit (72e0826) made this repo a live example of the action in use. Users benefit from seeing a real implementation, not just example snippets. The new section provides context and encourages copy-paste adaptation. Closing issue — documentation is now up to date.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
v1
Labels
Clear labels   
update-docs

Automated documentation review

No labels
update-docs
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
intern
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
actions/update-docs#1
No description provided.