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

docs need screenshots #20

Open
CouldBeThis opened this issue May 28, 2023 · 1 comment
Open

docs need screenshots #20

CouldBeThis opened this issue May 28, 2023 · 1 comment

Comments

@CouldBeThis
Copy link

I stumbled on this project and it looks cool! I am looking for something like this.

The documentation is pretty confusing because there are no screenshots. I am disoriented about what dialogue/menu is being described.

Is the documentation up to date with the current release?

If I made screenshots of all the windows, menus, dialogues as displayed for one of the sample files, would it be helpful? If so, which of the sample files would best to show the capabilities?

I could try to place the screenshots into the docs, but you'd need to proofread and likely correct it.

I would organize/name the screenshots in a logical way so that they would be able to be used when needed.

TreeLine version 3.1.5
written by Doug Bell

Library versions:
   Python:  3.10.10
   Qt:  5.15.2
   PyQt:  5.15.4
   OS:  Linux-6.1.29-1-MANJARO-x86_64-with-glibc2.37
@doug-101
Copy link
Owner

Yes, the docs should be current.

I don't have any problem with screenshots being added. Most of the documentation is in two different formats. If opened from TreeLine, they are in the form of a TreeLine file. The other format is on the web page, which is basically exported from the TreeLine file version. For the TreeLine file, a Picture field type could be added and populated where it made sense.

Having someone just provide the screenshots wouldn't help me much. Combining them with the documentation files is probably more work. I'd be happy to proof-read the resulting files.

I don't really have a preference for which sample files are used. In general, it should probably be relatively simple ones, but with enough detail to show what the given doc section is explaining.

Thanks,
Doug

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

No branches or pull requests

2 participants