Write user help about paperwork

[SquirrelNinja]

Hi,
I came across this project looking for an Evernote alternative. My background is Software Engineering. I would be happy to help document how this tool works, and then once I understand it, perhaps would have time to write some code. I have limited PHP experience, but can code in C, C++, Java, Ruby, Groovy and probably some others that have fallen by the wayside, so what's anther language?
Ping me if you are interested....

[mrusme]

@SquirrelNinja sure we are! Right now, there's already some technical information about setting up Paperwork on your own machine located within our Wiki: https://github.com/twostairs/paperwork/wiki

Regarding this issue here: As soon as you got your own Paperwork installation running, you might want to check out paperwork/frontend/app/help/, where there should be several index..md files. These files document the basics on how the documentation you can reach via through the /help URL work.

Now, for creating the user-documentation, the index files need to be altered in order to provide an actual index of all help topics available. Every topic should go into own ..md files. These files could even be organized using sub-folders, if needed.

Within these files documentation can be written using regular markdown. There are some special features that have been documented inside the index..md placeholders:

Help

Welcome to Paperwork! Here is, where the help is going to be. We introduced a few specialities to the > Markdown used to generate this help pages from:

• Help URLs: For linking to other help pages, simply use the following format: [this is a link](@help.folder.anotherfolder.file)
• Help images: For displaying images that are stored in the public/images/help/-folder, use this: ![my image](@image.ay-caramba.png "Ay caramba!")

That's pretty much everything needed to know about user help. :-)

[SquirrelNinja]

Hi,
I'm working on the install now. BTW - on the github page, the link to
composer takes you somewhere very bad... You should probably look at it...

Cheers,
Chuck

On Mon, Feb 9, 2015 at 2:51 PM, Marius [email protected] wrote:

@SquirrelNinja https://github.com/SquirrelNinja sure we are! Right now,
there's already some technical information about setting up Paperwork on
your own machine located within our Wiki:
https://github.com/twostairs/paperwork/wiki

Regarding this issue here: As soon as you got your own Paperwork
installation running, you might want to check out
paperwork/frontend/app/help/, where there should be several index..md
files. These files document the basics on how the documentation you can
reach via through the /help URL work.

Now, for creating the user-documentation, the index files need to be
altered in order to provide an actual index of all help topics available.
Every topic should go into own ..md files. These files could even be
organized using sub-folders, if needed.

Within these files documentation can be written using regular markdown.
There are some special features that have been documented inside the
index..md placeholders:

Help

Welcome to Paperwork! Here is, where the help is going to be. We
introduced a few specialities to the > Markdown used to generate this help
pages from:

• Help URLs: For linking to other help pages, simply use the following
  format: this is a link

• Help images: For displaying images that are stored in the
  public/images/help/-folder, use this:

  That's pretty much everything needed to know about user help. :-)

—
Reply to this email directly or view it on GitHub
#29 (comment).

[mrusme]

👍