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

Additional Documentation Updates - Images, Quickstart Pages, and Date Syntax #360

Merged
merged 5 commits into from
Jun 21, 2020

Conversation

vansia43
Copy link
Contributor

@vansia43 vansia43 commented Jun 10, 2020

This PR addresses the following documentation updates (covered via #243 ):

  • Update images to Adwaita GNOME theme

  • Remove Plugins and Preferences images. These UIs are explained, in-depth, within the manual. Images are not necessary and just another thing to update if there are changes in the future.

  • Did some work on the intro section to remove the Quickstart page. This page was unnecessary. The introduction was consolidated into two topics.

vansia43 added 3 commits June 7, 2020 22:35
The gtg-quickstart page was duplicative of what is on the
index and provided in the Overview of Main UI.
This page was removed and meson.build was updated.
Updates were also made to the index to consolidate
the Overview of the Main UI and the Keyboard Shortcuts
into an Introduction section.
These images are not needed because the help pages go
into detail on explaining these UIs. When updates are made
a new image will not need to be taken and just the text
will need to be edited. Meson.build is also updated.
Updated to a more logical order, describing UI elements from top to bottom of the main window.
@vansia43 vansia43 added the documentation "User manual" or "contributor documentation" issues label Jun 13, 2020
*Added gtg-date-parsing page to explain date syntax for literal and fuzzy dates
*Updated pages that refer to dates to link to new page
*Reformatting on index
*Updated meson.build with new page
@vansia43
Copy link
Contributor Author

vansia43 commented Jun 14, 2020

Added some more commits to this PR.

  • In 421e415 I wanted to reorder the UI elements in the main interface page into a logical order to explain their location in the UI.

  • 98995a7 tackled the work started in Thoroughly document the multilingual dates and keyword parsing syntax #340 . It addressed the TODO in the quickadd page and created a new page for the date parsing topic. Pages that discuss date options are linked here. I went through the code in dates.py and I believe I have grabbed all of the ways that you can reference dates, both literal and fuzzy.

@vansia43 vansia43 requested a review from nekohayo June 14, 2020 00:14
@vansia43 vansia43 changed the title Additional Documentation Updates - Images and Quickstart Pages Additional Documentation Updates - Images, Quickstart Pages, and Date Syntax Jun 14, 2020
@nekohayo nekohayo merged commit 1a9d547 into getting-things-gnome:master Jun 21, 2020
@nekohayo
Copy link
Member

Sorry for the delay, looks fantastic, A++ would merge again ;)

@vansia43 vansia43 deleted the userdocs branch June 21, 2020 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation "User manual" or "contributor documentation" issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants