-
Notifications
You must be signed in to change notification settings - Fork 591
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
Release 2.0 documentation #3593
Conversation
Thanks for updating all this! But… I really think there's a problem with the inline icons in the screenshots, they shouldn't be that big -- and they aren't on my end with Adwaita (which seems to be what you used, which makes sense to use IMO). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for updating the docs - I made a few tweaks.
Thank you, applied them all. |
@eht16 Thanks for doing the boring job!
No problem at all :-).
There were some fixes but nothing really major worth mentioning I think.
I don't think it's necessary, the big refactorings weren't user-visible. But maybe if #3049 gets merged, an "improved support of ctags file format" could be mentioned so users know they can use these files and there should be no issues with them.
I would maybe just rephrase "Improve user experience when creating new projects" to something like "Simplify project creation from existing directories with sources" to make it clearer what it is about. |
Yeah, will happily add it once it is merged 🤞
Done, thanks. |
It just got in 😉 |
Maybe also worth mentioning that this is the recommended way of generating tag files. |
doc/images/pref_dialog_various.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, the older screenshot shows some contrast between the list items. We kind of regressed here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is also theme-dependent, isn't it? I don't remember we changed anything in the dialog?
We could discuss if we do not want to use that theme for screenshots but given the time left, I would postpone this discussion to 2.1+.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is also theme-dependent, isn't it?
It is, unless we're explicitly asking for the theme to do something like that (there's an option I don't remember, but you're only supposed to use that if things would be hard to comprehend without, and otherwise let the theme decide).
doc/images/main_window.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the proportions of the older screenshot better (msgwin is huge now)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Me too but this is the great Adwaita we all love so much...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think Enrico wanted to show all the tabs of the message window but unfortunately these are the Adwaita's infamous "bloated and scaled up" tabs from #3063 so they take a huge amount of space :(.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But I think the message window could be made a tiny bit smaller and the whole window could be taller to compensate for this (if Enrico has a big enough monitor).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So far I tried to keep the width and height of the old screenshot. But I don't mind much.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed it could be bit improved having more room for the editor, event with Adwaita. And having it a bit taller is probably no problem. Something like this (though beware! it's a Git build and you can see it)
[edit] and my shadow is ugly, possibly because it was using most of the vertical space of my VM screen?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, so it's just getting bigger again. I pushed a variant with similar dimensions as @b4n's demo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@eht16 yeah… is it a problem in the generated file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, it just that the user reading the documentation would need a resolution big enough to match the screenshot dimensions or the user needs to scroll. But probably no big deal nowadays.
Awesome! Can't find words for how much I appreciative your effort. |
Given our discussions on themes and screenshots, maybe in the "Geany Workspace" section note that the screenshots are dead tortoise ... erm sorry Adwaita theme ;-P Perhaps after the first screenshot add "Screenshots in the document are the default GTK Adwaita theme, but Geany will adapt to the desktop GTK theme that is set." The fact that Geany follows the desktop setting actually isn't documented anywhere else AFAICT. Otherwise LGTM |
Done. |
You guys like to have me updating screenshots I guess... |
Nah, it could have totally stayed the way it was.
We are aiming for 1000 screenshot updates in this PR :-). |
8ac7883
to
09e82b5
Compare
You can add #3611 now ;) |
@eht16 looks like there has been a rebase mishap, and you grabbed some unrelated things in there 😕 |
09e82b5
to
e350698
Compare
I just did a quick rescan, raised one question, not critical just ignore if stupid :-) LGTM |
85febd1
to
d2186cc
Compare
LGTM |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New image is missing from the build system. Otherwise I didn't check all PR and issue references, but looks good! 👍
doc/images/edit_change_history.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not installed!
diff --git a/doc/Makefile.am b/doc/Makefile.am
index ea0e0f697..45dbeecef 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,6 +4,7 @@ if INSTALL_HTML_DOCS
htmldocimagesdir = $(docdir)/html/images
dist_htmldocimages_DATA = \
images/build_menu_commands_dialog.png \
+ images/edit_change_history.png \
images/find_dialog.png \
images/find_in_files_dialog.png \
images/main_window.png \
diff --git a/doc/meson.build b/doc/meson.build
index a9a2c0257..2fa8cab6d 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -19,6 +19,7 @@ tarball = run_command('test', '-f', 'geany.html', check: false)
if tarball.returncode() == 0 or rst2html.found()
install_data(
'images/build_menu_commands_dialog.png',
+ 'images/edit_change_history.png',
'images/find_dialog.png',
'images/find_in_files_dialog.png',
'images/main_window.png',
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@eht16 I took the liberty to push to this PR with the fix above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks and sorry.
37647e3
to
93070a5
Compare
Add NEWS for 2.0, update documentation screenshots and add docs for the "Change history" feature.
Remarks for the NEWS items:
Thanks @b4n, @kugel-, @elextr, @techee, @ntrel, @frlan and all the others!