Project Wiki as first-class citizen in Repository #9645

Open
opened 2025-11-02 08:45:17 -06:00 by GiteaMirror · 1 comment
Owner

Originally created by @aschrijver on GitHub (Oct 2, 2022).

Feature Description

Wiki's are not just scratchpads to dump random notes. They are integral part of the project. Yet both Github and Gitea offer wiki's as sort of 2nd-class citizens by not integrating deeply with the rest of the feature set.

Project wiki's are ideal to:

Were it not that wiki's aren't really integrated. As a result most wiki's encountered in-the-wild are silent backwaters where once a diligent developer documented something, and then the chore of keeping it up-to-date was too high.

Wiki integration

Some places where deeper integration is desirable (there may be more):

  • Ability to reference Issues and PR's from wiki commit msgs (e.g. docs: updated 'techstack' wiki page (#201))
    • The cross-reference entry becomes visible on the referenced Issue / PR just like for regular code commits
  • Wiki edits are shown in Product Activity feed (and people will also be aware if e.g. they have a Matrix chat bridge).
  • Wiki edits count as Contributions (i.e. on the colored dots calendar on someone's profile).
  • [Maybe] Other team members are notified of Wiki edits ("Folks, this is relevant to ya").

Update: Sideways related improvement..

  • Show Wiki Page Title in the OpenGraph link preview when dropping a page URL somewhere else (like in Matrix chatroom). Now the repo name is shown (repo on Codeberg).

Screenshots

No response

Originally created by @aschrijver on GitHub (Oct 2, 2022). ### Feature Description Wiki's are not just scratchpads to dump random notes. They are integral part of the project. Yet both Github and Gitea offer wiki's as sort of 2nd-class citizens by not integrating deeply with the rest of the feature set. Project wiki's are ideal to: - Maintain [_Living Documentation_](https://en.wikipedia.org/wiki/Living_document) owned by the dev team (those with edit privilege). - Because it is low-barrier to keep in sync (no PR'ing required). - Making it ideal for [_Readme Driven Development_](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html) (well, .. in the wiki then :) Were it not that wiki's aren't really integrated. As a result most wiki's encountered in-the-wild are silent backwaters where once a diligent developer documented something, and then the chore of keeping it up-to-date was too high. ### Wiki integration Some places where deeper integration is desirable (there may be more): - [ ] Ability to reference Issues and PR's from wiki commit msgs (e.g. `docs: updated 'techstack' wiki page (#201)`) - The cross-reference entry becomes visible on the referenced Issue / PR just like for regular code commits - [ ] Wiki edits are shown in Product Activity feed (and people will also be aware if e.g. they have a Matrix chat bridge). - [ ] Wiki edits count as Contributions (i.e. on the colored dots calendar on someone's profile). - [ ] [Maybe] Other team members are notified of Wiki edits ("Folks, this is relevant to ya"). **Update**: Sideways related improvement.. - [ ] Show Wiki Page Title in the OpenGraph link preview when dropping a page URL somewhere else (like in Matrix chatroom). Now the repo name is shown (repo on Codeberg). ### Screenshots _No response_
GiteaMirror added the type/proposaltype/feature labels 2025-11-02 08:45:17 -06:00
Author
Owner

@git-78 commented on GitHub (Jan 29, 2023):

+1. We had that in an old unmaintained bugtracker and that was so efficient and useful...

@git-78 commented on GitHub (Jan 29, 2023): +1. We had that in an old unmaintained bugtracker and that was so efficient and useful...
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#9645