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

Release 2.0 documentation #3593

Merged
merged 3 commits into from
Oct 19, 2023
Merged

Conversation

eht16
Copy link
Member

@eht16 eht16 commented Oct 11, 2023

Add NEWS for 2.0, update documentation screenshots and add docs for the "Change history" feature.

Remarks for the NEWS items:

  • I left out names for Jiří and Thomas as you count as core developers for long I'd say. This doesn't mean your work is less appreciated ❤️
  • I skipped many smaller or non user visible changes or follow-up PRs to not bloat the list too much
  • @techee are tere any macOS specific items missing?
  • if anyone miss his favorite PR or so, shout out
  • based on the amount of commits and PRs, this is a Jiří+Thomas release :). Thank you!
  • Should we maybe better highlight the many ctags changes?

Thanks @b4n, @kugel-, @elextr, @techee, @ntrel, @frlan and all the others!

@b4n
Copy link
Member

b4n commented Oct 11, 2023

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).

Copy link
Member

@ntrel ntrel left a 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.

NEWS Outdated Show resolved Hide resolved
doc/geany.txt Outdated Show resolved Hide resolved
doc/geany.txt Outdated Show resolved Hide resolved
@eht16
Copy link
Member Author

eht16 commented Oct 11, 2023

Thanks for updating the docs - I made a few tweaks.

Thank you, applied them all.

@techee
Copy link
Member

techee commented Oct 11, 2023

@eht16 Thanks for doing the boring job!

I left out names for Jiří and Thomas as you count as core developers for long I'd say. This doesn't mean your work is less appreciated ❤️

No problem at all :-).

@techee are tere any macOS specific items missing?

There were some fixes but nothing really major worth mentioning I think.

Should we maybe better highlight the many ctags changes?

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.

if anyone miss his favorite PR or so, shout out

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.

@eht16
Copy link
Member Author

eht16 commented Oct 11, 2023

Should we maybe better highlight the many ctags changes?

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.

Yeah, will happily add it once it is merged 🤞

if anyone miss his favorite PR or so, shout out

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.

Done, thanks.

@b4n
Copy link
Member

b4n commented Oct 17, 2023

Yeah, will happily add it once it is merged 🤞

It just got in 😉

@techee
Copy link
Member

techee commented Oct 17, 2023

"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.

Maybe also worth mentioning that this is the recommended way of generating tag files.

NEWS Outdated Show resolved Hide resolved
doc/images/replace_dialog.png Outdated Show resolved Hide resolved
Copy link
Member

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.

Copy link
Member Author

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+.

Copy link
Member

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).

Copy link
Member

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)

Copy link
Member Author

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...

Copy link
Member

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 :(.

Copy link
Member

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).

Copy link
Member Author

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.

Copy link
Member

@b4n b4n Oct 17, 2023

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)
main_window
[edit] and my shadow is ugly, possibly because it was using most of the vertical space of my VM screen?

Copy link
Member Author

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.

Copy link
Member

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?

Copy link
Member Author

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.

NEWS Outdated Show resolved Hide resolved
@kugel-
Copy link
Member

kugel- commented Oct 17, 2023

Awesome! Can't find words for how much I appreciative your effort.

doc/geany.txt Show resolved Hide resolved
@elextr
Copy link
Member

elextr commented Oct 18, 2023

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

@eht16
Copy link
Member Author

eht16 commented Oct 18, 2023

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."

Done.

doc/geany.txt Outdated Show resolved Hide resolved
@eht16
Copy link
Member Author

eht16 commented Oct 18, 2023

You guys like to have me updating screenshots I guess...
The screenshot for the prefs dialog with the changed default for the tab label length is updated for 1000 chars, pixels, apples, Euros 😄.

@techee
Copy link
Member

techee commented Oct 18, 2023

You guys like to have me updating screenshots I guess...

Nah, it could have totally stayed the way it was.

The screenshot for the prefs dialog with the changed default for the tab label length is updated for 1000 chars, pixels, apples, Euros 😄.

We are aiming for 1000 screenshot updates in this PR :-).

@b4n
Copy link
Member

b4n commented Oct 18, 2023

You can add #3611 now ;)

@b4n
Copy link
Member

b4n commented Oct 18, 2023

@eht16 looks like there has been a rebase mishap, and you grabbed some unrelated things in there 😕

@eht16
Copy link
Member Author

eht16 commented Oct 18, 2023

@eht16 looks like there has been a rebase mishap, and you grabbed some unrelated things in there 😕

Oops, thanks for notifying. Should be fixed.
I started a first round of squashing the incremental changes and then came #3611 :).

You can add #3611 now ;)

Done.

@eht16
Copy link
Member Author

eht16 commented Oct 18, 2023

@elextr @kugel- @b4n could you have a look on the yet open discussions and either resolve or comment on them? We are slightly running out of time.

NEWS Outdated Show resolved Hide resolved
@elextr
Copy link
Member

elextr commented Oct 18, 2023

I just did a quick rescan, raised one question, not critical just ignore if stupid :-)

LGTM

@kugel-
Copy link
Member

kugel- commented Oct 18, 2023

LGTM

Copy link
Member

@b4n b4n left a 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! 👍

Copy link
Member

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',

Copy link
Member

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks and sorry.

@eht16 eht16 merged commit e9af6b5 into geany:master Oct 19, 2023
4 checks passed
@eht16 eht16 deleted the release_2_0_documentation branch October 19, 2023 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants