Skip to content

Fix visuals of tutorial notebooks #1328

Closed
Mr-Geekman opened this issue Jul 24, 2023 · 1 comment
Closed

Fix visuals of tutorial notebooks #1328

Mr-Geekman opened this issue Jul 24, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request priority/high High priority task

Comments

@Mr-Geekman
Copy link
Contributor

Mr-Geekman commented Jul 24, 2023

🚀 Feature Request

There are some problems with visual representation of the tutorial notebooks in the documentation, we should fix them and unify the style of notebooks.

Proposal

Problems in tutorials:

  • Poor representation of dataframes: bad alignment, it was better in the old version of documentation
  • Not working table of contents
    • It isn't critical because TOC is displayed on the right panel of the web-site
  • Not working binder button
  • Inconsistent naming of sections across different tutorials, there should be some standardized way
    • If we use digits we should use it everythere.
    • We should use the same title hierarchy.
  • Inconsistent placing of imports. We should place imports the same way in each tutorial.
    • I'm not sure is that necessary or not.
  • Inconsistent metion of extras necessary to install. It should be at the very top of the tutorial for each of them.

Add created specification for styling of notebooks into contribution guide.

Test cases

No response

Additional context

Developing in docs-prototype branch.

@Mr-Geekman Mr-Geekman added the enhancement New feature or request label Jul 24, 2023
@Mr-Geekman Mr-Geekman added this to the Documentation rework milestone Jul 24, 2023
@Mr-Geekman Mr-Geekman added priority/high High priority task documentation Improvements or additions to documentation labels Jul 24, 2023
@Mr-Geekman Mr-Geekman self-assigned this Jul 24, 2023
@Mr-Geekman
Copy link
Contributor Author

Closed by #1330.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request priority/high High priority task
Projects
Status: Done
Development

No branches or pull requests

1 participant