You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
pavithraes opened this issue
Feb 21, 2024
· 0 comments
· Fixed by #116
Assignees
Labels
part: documentationImprovements/bugs/changes to documentationtag: internalIssues and PRs for maintainance of the project - not interesting to external users
Is your feature request related to a problem? Please describe.
Using GitHub wiki for docs doesn't allow us to have "reviews" in the documentation contribution workflow.
Describe the solution you'd like
Move the wiki pages into the repository as markdown files, and create an action that moves text over to the wiki. This means we'll treat the wiki as a read-only space.
This also allows us to have linting and testing to ensure consistency.
Describe alternatives you've considered
A docs website is the ideal solution, but is currently not do-able. However, having docs in the repo will allow easier transition to a docs generator if/when that happens.
part: documentationImprovements/bugs/changes to documentationtag: internalIssues and PRs for maintainance of the project - not interesting to external users
Is your feature request related to a problem? Please describe.
Using GitHub wiki for docs doesn't allow us to have "reviews" in the documentation contribution workflow.
Describe the solution you'd like
Move the wiki pages into the repository as markdown files, and create an action that moves text over to the wiki. This means we'll treat the wiki as a read-only space.
This also allows us to have linting and testing to ensure consistency.
Describe alternatives you've considered
A docs website is the ideal solution, but is currently not do-able. However, having docs in the repo will allow easier transition to a docs generator if/when that happens.
Additional context
This was discussed with @ptomecek and @robambalu in a meeting today.
Next steps:
The text was updated successfully, but these errors were encountered: