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

User guides #177

Merged
merged 20 commits into from
Aug 3, 2023
Merged

User guides #177

merged 20 commits into from
Aug 3, 2023

Conversation

pseusys
Copy link
Collaborator

@pseusys pseusys commented Jul 26, 2023

Description

User guides is the new documentation partition containing article-style tutorials.

Checklist

  • I have covered the code with tests
  • I have added comments to my code to help others understand it
  • I have updated the documentation to reflect the changes
  • I have performed a self-review of the changes

@pseusys pseusys added the documentation Improvements or additions to documentation label Jul 26, 2023
@pseusys pseusys requested a review from kudep July 26, 2023 14:27
@pseusys pseusys self-assigned this Jul 26, 2023
Copy link
Member

@RLKRo RLKRo left a comment

Choose a reason for hiding this comment

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

I fixed some errors that I found in the commit.

docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
@pseusys pseusys marked this pull request as ready for review August 2, 2023 17:46
Copy link
Member

@RLKRo RLKRo left a comment

Choose a reason for hiding this comment

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

Added a commit with minor changes: 6b63499.

EDIT: also, we have an option "header_links_before_dropdown": 7, due to which the about us section is getting moved to the more section.
image

I think we should either increase the limit or decrease it (so that, for example, development, community and about us would all be in the more section).

docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
docs/source/user_guides/basic_conceptions.rst Outdated Show resolved Hide resolved
@pseusys
Copy link
Collaborator Author

pseusys commented Aug 2, 2023

Speaking of "header_links_before_dropdown": 7, let's increase it, it will collapse some sections if they don't fit into screen automatically.

@RLKRo
Copy link
Member

RLKRo commented Aug 2, 2023

BTW, here's how both options look like:

  1. "header_links_before_dropdown": 8,:
    image
  2. "header_links_before_dropdown": 5,
    image

docs/source/conf.py Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
@pseusys pseusys requested review from ruthenian8 and RLKRo August 3, 2023 11:15
@ruthenian8
Copy link
Member

IMHO, still need to run a grammar check with ChatGPT

@kudep kudep merged commit c17bb14 into dev Aug 3, 2023
@kudep kudep deleted the feat/user_guides branch August 3, 2023 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants