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

Enhance Structure of the Official CoCalc Documentation for Jupyter Notebooks #67

Open
Blaec-CoCalc opened this issue Dec 19, 2024 · 0 comments

Comments

@Blaec-CoCalc
Copy link

Screenshot 2024-12-19 at 12 46 08 PM

Categorization: Feature Request

Is your feature request related to a problem? Please describe.
The current CoCalc Documentation Page for Jupyter Notebooks lacks detailed structural information in key areas, making it difficult for users to effectively navigate and access needed content.

Describe the solution you'd like
Introduce submenus for each of the main content points—Getting Started with Jupyter Notebooks, CoCalc Enhancements to Jupyter Notebooks, and Jupyter Tips and Tricks. These submenus should be collapsible for better navigation and include detailed items such as:

For "Getting Started with Jupyter Notebooks":

  • What’s a Jupyter Notebook?
  • Jupyter Kernels
  • Basic Features
    • menu bar
    • button row
    • active cell
    • execution counter
    • code cell output
    • select multiple cells
    • text cells
    • saving

For "CoCalc Enhancements to Jupyter Notebooks":

  • cell-insert bar
  • consecutive cell numbers
  • drag-and-drop
  • nbgrader integration
  • protect cells from deletion
  • protect cells from editing
  • run time for compute cells
  • slideshow
  • table of contents
  • widgets in CoCalc

For "Jupyter Tips and Tricks":

  • Run Jupyter notebook with GPU support
  • Customize Jupyter notebook LaTeX export settings
  • Embed a CoCalc project in your website
  • Notebook too large? Remove output.
  • Play a .wav file in a Jupyter notebook
  • Remove Local Files to Troubleshoot a Notebook
  • Use the Halt Button to Conserve Memory

Include relevant links to additional resources or helpful pages.

Describe alternatives you've considered
An alternative could be a nested table of contents at the beginning of the page that lists all these items, although collapsible submenus might offer a cleaner, less overwhelming interface.

Additional context
This update will navigate the documentation smoother, enhance user understanding, and improve the overall user experience by providing comprehensive information on how to utilize Jupyter Notebooks within CoCalc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant