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.

Sign up for GitHub

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

Jump to bottom

Doc Review: Sorting.md #71

Closed
meichthys opened this issue Jul 4, 2024 · 0 comments
Closed

Doc Review: Sorting.md #71

meichthys opened this issue Jul 4, 2024 · 0 comments
Assignees
@Alumniminium
Labels
documentation Improvements or additions to documentation initial-review adds to initial-review project

Comments

@meichthys
Copy link
Contributor

Please ensure the following:
- Without any previous knowledge about Trilium, can I accomplish what's explained in the documentation by strictly following only what's written in it?
- Is the language clear and unambiguous?
- Any language issues/misspellings or deviation from terminology used elsewhere in docs?
- Are more screenshots needed?
- Is the division of the document well structured using headings?
- Are step by step instructions marked with numbered lists?
- Do existing screenshots reflect current version? If not, create new ones.
@Alumniminium Alumniminium self-assigned this Jul 20, 2024
Alumniminium added a commit to Alumniminium/TriliumDocs that referenced this issue Jul 20, 2024
@Alumniminium
TriliumNext#71
a083c63
@Alumniminium Alumniminium mentioned this issue Jul 20, 2024
Merged
meichthys added a commit that referenced this issue Aug 6, 2024
@Alumniminium @root-hal9000 @meichthys
Initial review -> Master for upcoming Notes release (#101)
e60b640 
* #84

* #84 - fix more grammar issues

* #84 - fix more grammar issues

* Some more :D

* Update #14

* Make changes @root-hal9000 suggested

* Updated Document article

Among other edits, renamed the "document" concept to be called what it actually is, the database - which could help avoid confusion with the concept of "note"

* Changed all references to document to database

-  Changed references to document to say database
- Changed references to "demo document" to "demo notes"
-  renamed document.md to database.md and replaced in links
- Changed location of database in TOC to go under advanced usage
Issue #32

* fixed links change during merge conflict

* #84

* #83

* #82

* #81

* #81

* #79

* #78

* #75

* #74

* #72

* #71

* #68

* #64

* #61

* Review PR #94

* Review PR #94 - Url Encoding

* Add missing images

* add missing image to template.md

* template-create-instance-note.png

* closes #12

* Closes #16

* Closes #17

* Closes #18

* Closes #20

* Closes #31

* clarify the location of options

* add tics around `true` and add newline at end of file

* Remove period from non-sentence lines

* add "(or `viewType` attribute)"

* reference docker installation docs directly instead of other third party website.

* simplify wording

* Update docker image references

* Reference new documentation

* One more docker reference updated

* Remove documenation warning

* Remove warning label

---------

Co-authored-by: root-hal9000 <2352828+root-hal9000@users.noreply.github.com>
Co-authored-by: MeIchthys <github.com@meichthys.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Alumniminium Alumniminium

Labels
documentation Improvements or additions to documentation initial-review adds to initial-review project
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@meichthys @Alumniminium