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

Make a real user and developer manual. #17

Open
sebsauvage opened this issue Feb 26, 2013 · 9 comments
Open

Make a real user and developer manual. #17

sebsauvage opened this issue Feb 26, 2013 · 9 comments
Assignees

Comments

@sebsauvage
Copy link
Owner

Maybe on the wiki ?

User manual:

  • How to install Shaarli.
  • How to upgrade.
  • How to backup/restore.
  • etc.

Developer manuel:

  • Storage architecture
  • Classes and functions
  • Security handling
  • etc.
@ghost ghost assigned sebsauvage Feb 26, 2013
@ghost
Copy link

ghost commented Feb 27, 2013

Please include some tricks on Shaarli usage in the user doc (thinking about http://sebsauvage.net/links/?bSmebQ).
We could start working on the user manual on a pad like https://pad.riseup.net/ or https://pad.lqdn.fr/

@sebsauvage
Copy link
Owner Author

You're right. These usages could be listed.

Besides, there are plenty of features which are not well documented (such as filtered feeds, filtered picture wall, etc.)

@ghost
Copy link

ghost commented Mar 8, 2013

J'ai commencé un bout de manuel (en français) ici https://pad.lqdn.fr/p/shaarliuserdoc
Les contributions sont les bienvenues, je pense que ce serait un bon début de répondre aux questions qui sont posées sur http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion et de renvoyer les gens vers la doc
J'ai déjà posé quelques idées de documentation sur le pad. Si chacun y passe 5 minutes ca ira très vite.
A vos claviers...

@nodiscc
Copy link

nodiscc commented Jul 26, 2014

Work on documentation started at https://github.com/shaarli/Shaarli/wiki, feel free to contribute

@e2jk
Copy link

e2jk commented Jul 26, 2014

@nodiscc I think the documentation should be in English.
As a French native speaker, I appreciate reading the information in my language, but we must not forget the other users as well.

What about making the primary pages on the wiki in English, with other pages for other languages if available?

@Sbgodin
Copy link
Contributor

Sbgodin commented Jul 26, 2014

Same for me. French native. I would also suggest Esperanto, easier to understand at first glance.

@pVesian
Copy link

pVesian commented Jul 27, 2014

I think there are more english speakers than esperanto's in the developers
community.

@Sbgodin
Copy link
Contributor

Sbgodin commented Jul 27, 2014

Indeed ;-) Most of Esperanto speaker, on the internet, also speak English.

@nodiscc
Copy link

nodiscc commented Jul 27, 2014

the documentation should be in English.

Right, the paragraphs in french have been copied from https://pad.lqdn.fr/p/shaarliuserdoc. Ideally they should be translated to english, and moved to $PAGENAME.fr

@nodiscc
Copy link

nodiscc commented Aug 27, 2014

major update at https://github.com/shaarli/Shaarli/wiki (i gathered more already existing docs, starting at http://sebsauvage.net/wiki/doku.php?id=php:shaarli and following links)

@nodiscc
Copy link

nodiscc commented Aug 27, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants