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 development-focused documentation into this repo #2741

Closed
djmitche opened this issue Mar 4, 2022 · 3 comments · Fixed by #2742
Closed

Move development-focused documentation into this repo #2741

djmitche opened this issue Mar 4, 2022 · 3 comments · Fixed by #2742
Assignees

Comments

@djmitche
Copy link
Collaborator

djmitche commented Mar 4, 2022

Currently, development documentation is on tw.org. That's a bit problematic:

  • It's in HTML right now, making it difficult to edit and maintain (and it very much is not maintained). The project to convert to markdown is rather bogged down and has quite a ways to go.
  • It's versioned separately from development, so it's difficult to find docs for older versions or correlate docs and code changes.
  • There's a lot of automated GH activity on the tw.org repo which makes it pretty hard to find changes.

I'd like to move the design documents, as well as the coding style, into this repo, either as markdown for viewing in GitHub, or as a simple "GitHub Pages" branch appearing at https://gothenburgbitfactory.github.io/taskwarrior (which would be labeled clearly with links to taskwarrior.org for user docs).

Followups would include

  • writing up the RFC process as it is
  • writing a new RFC for the Sync Overhaul project
  • documenting the current data model

Before I get started: @tbabej @lauft what do you think?

@djmitche djmitche self-assigned this Mar 4, 2022
@gour
Copy link

gour commented Mar 5, 2022

Whatever brings this project to a better shape, is very much welcome! I finally gave up on Emacs/org-mode and would like Taskwarrior to thrive.

@djmitche djmitche moved this to Todo in Sync Overhaul Mar 5, 2022
@djmitche djmitche moved this from Todo to In Progress in Sync Overhaul Mar 5, 2022
@lauft
Copy link
Member

lauft commented Apr 15, 2022

I would strongly advocate for simple markdown for viewing in GitHub.

It is sufficient for developers (judging from me 😬) and keeps maintenance at a minimum.

@djmitche
Copy link
Collaborator Author

@lauft do you want to comment on the PR?

Repository owner moved this from In Progress to Done in Sync Overhaul May 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants