Skip to content

Add cheetsheat template and improve example visibility - #506

Merged
dipinknair merged 5 commits into
mainfrom
feat/example-visibility
Nov 28, 2023
Merged

dipinknair merged 5 commits into
mainfrom
feat/example-visibility

Conversation

@dipinknair

Copy link
Copy Markdown
Contributor

image

Add cheat sheet on index page. and adjust the examples tab to 3rd position

@github-actions github-actions Bot added documentation Improvements or additions to documentation enhancement New features or code improvements labels Nov 22, 2023
@RobPasMue

Copy link
Copy Markdown
Member

Top bar looks completely off... get all titles to be in the same level

@RobPasMue

Copy link
Copy Markdown
Member

Top bar looks completely off... get all titles to be in the same level

This is caused by the search bar mostly

@dipinknair

Copy link
Copy Markdown
Contributor Author

Top bar looks completely off... get all titles to be in the same level

This is caused by the search bar mostly

The search bar alignment issues comes from the fact that we have section title names which are long. By default we sphinx theme shows 5 sections and rest of them under more. To fix this,

  • option 1
    Reduce the number of sections shows in page to 4 and keep others under more like below.

image


or we can change the length of the title like below.

  • option 2
    mechanical scripting -> Scripting
    Remote Session -> Remote
    Embedded Instance -> Embedded
    API References -> API

@koubaa @RobPasMue . Which one do you think better?

@github-actions github-actions Bot added maintenance Package and maintenance related CI/CD labels Nov 22, 2023
@RobPasMue

Copy link
Copy Markdown
Member

I would go with option 1 - but up to you guys

…t/example-visibility

# Conflicts:
#	.github/workflows/ci_cd.yml
#	CHANGELOG.md
@dipinknair

Copy link
Copy Markdown
Contributor Author

Final look @RobPasMue @koubaa
image

@dipinknair
dipinknair requested a review from klmcadams November 28, 2023 18:52

@klmcadams klmcadams left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me!

@dipinknair
dipinknair merged commit 03eec66 into main Nov 28, 2023
@dipinknair
dipinknair deleted the feat/example-visibility branch November 28, 2023 20:05
@RobPasMue

Copy link
Copy Markdown
Member

Much better, thanks @dipinknair

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 enhancement New features or code improvements maintenance Package and maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants