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

Improve documentation #284

Open
5 of 14 tasks
graahnul-grom opened this issue Dec 2, 2018 · 8 comments
Open
5 of 14 tasks

Improve documentation #284

graahnul-grom opened this issue Dec 2, 2018 · 8 comments

Comments

@graahnul-grom
Copy link
Task lists! Give feedback
Member

@graahnul-grom graahnul-grom commented Dec 2, 2018

  1. Most of the README file content should be moved to
    a new INSTALL file. This file should also include a link
    to the Lepton EDA and Cygwin wiki page.
  2. README should be extended to provide more information
    about the Lepton EDA suite:
  • it was forked by main geda-gaf developers
  • it is compatible with (and direct replacement for) geda-gaf
  • list of new features: link to NEWS file
  • what systems are supported
  • binary packages available
  • how to build it (link to INSTALL file)
  • link to (wiki) page with screenshots (maybe embed 1-2 screenshots
    in README itself)
  • lepton-eda can easily be extended through the rich (and very well documented) Scheme API (GNU Guile)
  1. Some documents should be included in the installation
    (share/doc/lepton-eda/):
  • README
  • NEWS
  • Configuration settings (included in the reference manual)
  • Attributes wiki pages (should be added to the manual)
  1. A new Configuration (HTML) document should be added;
    add a new Help->Configuration menu item for it.
    This document should contain:
  • description of component-library and source-library options and
    where to place them. This is the most misunderstood subject. Wiki page
    (wiki/geda-gschem_ug-config.html) is not clear enough on that.
  • links to all files (local wiki, man pages, maybe web pages)
    with information on how to configure various tools in the Lepton EDA suite.
  1. Create a tutorial for novice Lepton users, either as part of
    the Lepton EDA Reference Manual or a separate (wiki?) document.
    It's not suitable anymore to advise users to read gEDA wiki docs:
    updated interface, different command names, new features like
    configuration system (among others), require us to make new,
    Lepton-specific docs.
    Tutorial should be as simple as possible (no gTAG stuff, please).
    It should contain many pictures, screenshots and links to
    other parts of documentation, web sites and communication
    channels.

UPDATE: Wiki page with Lepton EDA screenshots has been added.

@graahnul-grom
Copy link
Member Author

@graahnul-grom graahnul-grom commented Dec 18, 2018

One more item to add to the README file:

  • lepton-eda can easily be extended through the rich (and very well documented) Scheme API (GNU Guile).

I'd also consider adding guile to the list of "topics" (keywords shown at the top of the github repo page).

@vzh
Copy link
Member

@vzh vzh commented Dec 18, 2018

I've added guile, as well as c and geda to the topic list.

@graahnul-grom
Copy link
Member Author

@graahnul-grom graahnul-grom commented May 19, 2019

I think it's also worth installing the Scheme API reference manual HTML files.
We already installing HTML man page, so why not?

@vzh
Copy link
Member

@vzh vzh commented May 20, 2019

Agreed. While I myself like plain info documentation, some users could prefer HTML.

@graahnul-grom
Copy link
Member Author

@graahnul-grom graahnul-grom commented Nov 12, 2019

Having four help items in the Help menu is excessive.
They all point to essentially the same outdated wiki documentation
pages, one click away one from the other.
I think just one item (gEDA Wiki) would be enough.

@vzh
Copy link
Member

@vzh vzh commented Nov 12, 2019

The menu should be reviewed, I believe. We have to somehow refactor the old docs from gEDA wiki and merge it with our up-to-date documentation (if any). I think we could move the docs first to our wiki, and then probably to another repository.

@graahnul-grom
Copy link
Member Author

@graahnul-grom graahnul-grom commented Feb 9, 2020

@vzh So, should we remove those excessive items now?

help_menu

@graahnul-grom
Copy link
Member Author

@graahnul-grom graahnul-grom commented Feb 10, 2020

github wiki is pathetic. It can't be helped.
I seriously doubt that it's worth our time and
effort to make content for it. Most likely, it
will result in double work in near future.
Look how ugly those shrunk images are [1] [2];
and display size doesn't matter. As I said
elsewhere, we can forget about tables and pictures
(especially, screenshots: "Hey, folks, see how
scary our app looks like!").
When the user opens our wiki, he is greeted with
the half-screen github advertisement banner (in
the best traditions of malicious rogue sites),
which is absolutely irrelevant. Bad impressions
are guaranteed.

[1] https://github.com/lepton-eda/lepton-eda/wiki/Screenshots
[2] https://github.com/lepton-eda/lepton-eda/wiki/Verilog-example

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

Successfully merging a pull request may close this issue.

None yet
2 participants