search

LibrePCB / librepcb-rfcs

MOVED TO https://librepcb.discourse.group/
Apache License 2.0
3 stars 0 forks source link

Documentation crosslinking structure #7

Closed hephaisto closed 6 years ago

hephaisto commented 6 years ago

When I started to read about LibrePCB, it took me quite a while to find all necessary resources. For example, I haven't found any link to the doxygen files on the README.md. They link to something referred to as "documentation", but what is rather a "user manual" - at least when I read "documentation", I would expect something a lot more technical and detailled. I actually found out how to build the docs myself before I found out where to find the generated doxygen files online. It actually took me about 10 minutes to find it and it only worked to google "librepcb doxygen" (for the record, its here: http://librepcb.org/LibrePCB-Doxygen/master/ ). I would suggest to modify occurrences of "documentation" to something like "manual" and add a link to the doxy files on a few central pages (README.md of main repo, librepcb.org, ...) under the name "documentation".

I think it is obvious that a link to the doxy files is important, but would you concur with the proposed labelling above?

ubruhin commented 6 years ago

Makes sense to me. So I would summarize it in two points:

And maybe a third point:

hephaisto commented 6 years ago

I'm not sure whether the images in the doc directory really belong in the main repository. Maybe it would be better to put them in LibrePCB-doc.

I also think that a more verbose link label would be good. Something like:

ubruhin commented 6 years ago

I'm not sure whether the images in the doc directory really belong in the main repository.

These are only images used in the README.md of the main repository.

I also think that a more verbose link label would be good.

:+1:

ubruhin commented 6 years ago

Fixed by @hephaisto in https://github.com/LibrePCB/LibrePCB/pull/244.

Remove "doc" directory (move images to "img/") because there is no documentation in the main repository

This could still be done some day later...