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

Tidy up documentation for print #665

Open
alikstimix opened this issue Jul 17, 2024 · 3 comments
Open

Tidy up documentation for print #665

alikstimix opened this issue Jul 17, 2024 · 3 comments
Labels
no-issue-activity No activity on this issue

Comments

@alikstimix
Copy link
Contributor

Having a "print view layout" page separate from the "overview" page looks like overkill.

I recommend merging the first two paragraphs and the overlay section into the "overview" page, then deleting the "print view layout" page.

@paperdigits
Copy link
Contributor

paperdigits commented Jul 18, 2024 via email

@alikstimix
Copy link
Contributor Author

Well I was going to come on to that! The idea of a common structure seems to have lapsed a bit, and some tidying up in each section could restore a common structure with general information at the top level, detailed information at the bottom.

Each of the 6 views has a top level with no text, just a bulleted list of sections starting with "overview" and ".. view layout"

The overview sections differ wildly in content:
Lighttable just has another bulleted list of shortcuts
Darkroom has nothing much in the overview
Tethering has a bulleted list of shortcuts
Maps describes how to use the maps view
Slideshow just has some boilerplate text
Print has some two sentences of basic howto then 2 paragraphs of technical discussion

The view layout sections do follow a standard format (apart from slideshow) listing all the modules that can be accessed, with a short description and a link to their page of detailed info

So taking your point onboard, it seems like the content of the overview section needs to be reallocated with a sentence of general description going upward, and the rest merging downward as a navigation section of the ..view_layout page

If the common structure is clear, then it should be easier to relocate some of the detailed material that is currently scattered across the patch.

Copy link

This issue has not had any activity in the past 60 days and will be closed in 365 days if not updated.

@github-actions github-actions bot added the no-issue-activity No activity on this issue label Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-issue-activity No activity on this issue
Projects
None yet
Development

No branches or pull requests

2 participants