[GH-ISSUE #663] Review all documentation #336

New issue

Closed

opened 2026-02-25 23:33:59 +03:00 by kerem · 4 comments

kerem commented

2026-02-25 23:33:59 +03:00

Owner

Originally created by @fmartingr on GitHub (Jul 21, 2023).
Original GitHub issue: https://github.com/go-shiori/shiori/issues/663

Originally assigned to: @fmartingr on GitHub.

Review and rewrite all relevant parts of the documentation.

Acceptance criteria

Documentation reviewed
Removed old references
Re-structure the index
Update and modernice the README
Remove the FAQ (move important sections to their proper documentation areas)

Originally created by @fmartingr on GitHub (Jul 21, 2023). Original GitHub issue: https://github.com/go-shiori/shiori/issues/663 Originally assigned to: @fmartingr on GitHub. Review and rewrite all relevant parts of the documentation. ## Acceptance criteria - Documentation reviewed - Removed old references - Re-structure the index - Update and modernice the README - Remove the FAQ (move important sections to their proper documentation areas)

kerem

2026-02-25 23:33:59 +03:00

closed this issue
added the
priority:high

type:documentation
labels

kerem commented

2026-02-25 23:33:59 +03:00

Author

Owner

@jcn50 commented on GitHub (Aug 11, 2023):

How to import a list of bookmarks?... The documentation doesn't say, and there are no button to upload any file :(

@jcn50 commented on GitHub (Aug 11, 2023): How to import a list of bookmarks?... The documentation doesn't say, and there are no button to upload any file :(

kerem commented

2026-02-25 23:33:59 +03:00

Author

Owner

@fmartingr commented on GitHub (Aug 12, 2023):

How to import a list of bookmarks?... The documentation doesn't say, and there are no button to upload any file :(

Sadly, Import can only be done from the CLI. There's no way to import via the web interface at the moment.

@fmartingr commented on GitHub (Aug 12, 2023): > How to import a list of bookmarks?... The documentation doesn't say, and there are no button to upload any file :( Sadly, Import can only be done from the CLI. There's no way to import via the web interface at the moment.

kerem commented

2026-02-25 23:33:59 +03:00

Author

Owner

@horseDeveloper commented on GitHub (Aug 21, 2023):

Question/Suggestion: Is the ability to edit the bookmark property "Excerpt" (=the bookmark description, not the Title) only available via web-interface? I tried a simple shiori edit <number of the bookmark> in the CLI but it didn't work.

@horseDeveloper commented on GitHub (Aug 21, 2023): Question/Suggestion: Is the ability to edit the bookmark property "Excerpt" (=the bookmark description, not the Title) only available via web-interface? I tried a simple `shiori edit <number of the bookmark>` in the CLI but it didn't work.

kerem commented

2026-02-25 23:33:59 +03:00

Author

Owner

@fmartingr commented on GitHub (Dec 8, 2024):

Closed by #1018

@fmartingr commented on GitHub (Dec 8, 2024): Closed by #1018