search

ipfs / ipfs-desktop

An unobtrusive and user-friendly desktop application for IPFS on Windows, Mac and Linux.
https://docs.ipfs.tech/install/ipfs-desktop/
MIT License
6k stars 865 forks source link

Create Help Page #51

Closed dignifiedquire closed 5 years ago

dignifiedquire commented 9 years ago

There should be some form of help/documentation page inside the app, so people can understand what the app is doing and how to use it.

RichardLitt commented 9 years ago

@Dignifiedquire: @RichardLitt: yes it would be great to get some help on that, my idea was to do the setup once the PR is merged, as it has been long running enough for now, but if you want to start writing content in markdown format that would be great

Sweet!

dignifiedquire commented 9 years ago
dignifiedquire commented 9 years ago
  1. Create a directory called docs
  2. Create a window that renders those docs using a markdown renderer inside a nice help window
  3. Add ipfs sync capabilities to allow auto updates of those docs
hacdias commented 6 years ago

@diasdavid is this supposed to be done? If so, what should this Help page contain?

daviddias commented 6 years ago

This is a really old proposal (Oct 2015). Yes, docs are great but even greater is making sure that the IPFS GUI is cohesive so that part of the documentation is just UX.

Think about what can be done to improve, but avoid spending dozens of hours, if you feel like you need dozens of hours to make docs great, then think about UX of station+companion+webui first.

RichardLitt commented 6 years ago

so that part of the documentation is just UX.

A 30 sentence document will help developers understand what this is enough to be able to contribute and will go further towards collaboration and scaffolding this out faster than depending on the UX of the GUI. I'd say take a stab at it, @hacdias.

hacdias commented 6 years ago

Oh, I thought this was more about a end-user help page. For devs, we already started writing some stuff: https://github.com/ipfs-shipyard/ipfs-station#file-structure

RichardLitt commented 6 years ago

Ah, word. Yeah. In that case, David is probably right. Some basic text may help, though. The most use might be gotten out of drawing up some wireframes or user flows, and then implementing them in the GUI.

daviddias commented 6 years ago

In any case, @hacdias already did some valuable work to fulfil the need you described, @RichardLitt , check it out here https://github.com/ipfs-shipyard/ipfs-station#file-structure

hacdias commented 6 years ago

Should we close this?

hacdias commented 5 years ago

After more than I year, let's close this. The README contains information about how the app works. Now, IPFS Desktop is a relatively simple app and doesn't seem to need 'help'/how-to-use info.