search

TriliumNext / Docs

Documentation for TriliumNext
3 stars 3 forks source link

Doc Review: Release notes v0.48.md #63

Closed meichthys closed 2 weeks ago

meichthys commented 3 weeks ago

Please ensure the following:

  1. Without any previous knowledge about Trilium, can I accomplish what's explained in the documentation by strictly following only what's written in it?
  2. Is the language clear and unambiguous?
  3. Any language issues/misspellings or deviation from terminology used elsewhere in docs?
  4. Are more screenshots needed?
  5. Is the division of the document well structured using headings?
  6. Are step by step instructions marked with numbered lists?
  7. Do existing screenshots reflect current version? If not, create new ones.
Alumniminium commented 2 weeks ago
  1. N/A (Not Applicable for changelogs)
  2. TBD
  3. TBD
  4. N/A
  5. TBD
  6. N/A
  7. N/A

This being the only changelog page, I'd close this and discard the file.

meichthys commented 2 weeks ago

I'm working on mobile, but I deleted the file and committed it to the main branch, and I'm closing this now 👍

Alumniminium commented 2 weeks ago

I'm working on mobile, but I deleted the file and committed it to the main branch, and I'm closing this now 👍

Please don't push directly to main from now on, rather to the 'initial-review' branch :D

root-hal9000 commented 2 weeks ago

Yep. My original proposal was open PR to -review branch (which moves it to the peer review column in the project), someone else double checks/makes any other needed edits and then merges to initial review branch. When all issues are completed, merge initial review to main. But let me know if that sounds too clunky

Edit: although I just realized this issue was just a file delete, I meant the peer review PR for all the actual editing pages stuff

meichthys commented 2 weeks ago

I agree. we should not be committing directly to main. I'll use my own forks in the future for smaller things like this 👍