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

Review all documentation #663

Open
fmartingr opened this issue Jul 21, 2023 · 3 comments · May be fixed by #703
Open

Review all documentation #663

fmartingr opened this issue Jul 21, 2023 · 3 comments · May be fixed by #703
Assignees
@fmartingr
Labels
priority:high type:documentation
Milestone
1.8.0

Comments

@fmartingr
Copy link
Member

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)
@fmartingr fmartingr added this to the 1.6.0 milestone Jul 21, 2023
@fmartingr fmartingr self-assigned this Jul 21, 2023
@jcn50
Copy link

jcn50 commented Aug 11, 2023

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

@fmartingr
Copy link
Member Author

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 fmartingr linked a pull request Aug 20, 2023 that will close this issue
Draft
@horseDeveloper
Copy link

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.

@fmartingr fmartingr removed this from the 1.6.0 milestone Sep 10, 2023
@Monirzadeh Monirzadeh mentioned this issue Jan 23, 2024
Closed
@fmartingr fmartingr added this to the 1.8.0 milestone May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fmartingr fmartingr

Labels
priority:high type:documentation
Projects
Roadmap
Status: To do
Milestone
1.8.0
Development

Successfully merging a pull request may close this issue.

#WIP: Documentation revamp go-shiori/shiori
3 participants
@fmartingr @jcn50 @horseDeveloper