Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move docs into the repository #112

Closed
3 tasks
pavithraes opened this issue Feb 21, 2024 · 0 comments · Fixed by #116
Closed
3 tasks

Move docs into the repository #112

pavithraes opened this issue Feb 21, 2024 · 0 comments · Fixed by #116
Assignees
Labels
part: documentation Improvements/bugs/changes to documentation tag: internal Issues and PRs for maintainance of the project - not interesting to external users

Comments

@pavithraes
Copy link
Collaborator

pavithraes commented Feb 21, 2024

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:

  • Move the documentation as-is into the repo
  • Give attribution fairly - add everyone who originally authored the docs as co-authors on the PR
  • Add automation action
@pavithraes pavithraes added the part: documentation Improvements/bugs/changes to documentation label Feb 21, 2024
@pavithraes pavithraes self-assigned this Feb 21, 2024
@trallard trallard added the tag: internal Issues and PRs for maintainance of the project - not interesting to external users label Feb 21, 2024
@Point72 Point72 deleted a comment from poldpold Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part: documentation Improvements/bugs/changes to documentation tag: internal Issues and PRs for maintainance of the project - not interesting to external users
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants