Skip to content

Commit

Permalink
docs: fix title Overview and broken link (#3334)
Browse files Browse the repository at this point in the history
Fixes #3333
  • Loading branch information
mscolnick authored Jan 3, 2025
1 parent 04b1c83 commit dc8c4f0
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/guides/editor_features/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To access these settings, click the gear icon in the top-right of the editor:
A non-exhaustive list of settings:

- Outputs above or below code cells
- [Disable/enable autorun](../reactivity.md#runtime-configuration)
- [Disable/enable autorun](../reactivity.md#configuring-how-marimo-runs-cells)
- Package installation
- Vim keybindings
- Dark mode
Expand Down
3 changes: 0 additions & 3 deletions docs/guides/reactivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,6 @@ or try creating a new variable instead.
df["another_column"] = [3, 4]
```


## Global variable names must be unique

**marimo requires that every global variable be defined by only one cell.**
Expand All @@ -142,7 +141,6 @@ This lets marimo keep code and outputs consistent.
A variable can refer to any Python object. Functions, classes, and imported
names are all variables.


This rule encourages you to keep the number of global variables in your
program small, which is generally considered good practice.

Expand Down Expand Up @@ -178,7 +176,6 @@ _()

Here, the variables `plt`, `fig`, and `ax` aren't added to the globals.


## Configuring how marimo runs cells

Through the notebook settings menu, you can configure how and when marimo runs
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ hide:

marimo is a reactive Python notebook: run a cell or interact with a UI
element, and marimo automatically runs dependent cells (or [marks them as
stale](guides/reactivity.md#runtime-configuration)), keeping code and outputs
stale](guides/reactivity.md#configuring-how-marimo-runs-cells)), keeping code and outputs
consistent and preventing bugs before they happen. Every marimo notebook is
stored as pure Python, executable as a script, and deployable as an app.

Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/app-config/user-config-form.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -750,7 +750,7 @@ export const UserConfigForm: React.FC = () => {
Learn more in the{" "}
<a
className="text-link hover:underline"
href="https://docs.marimo.io/guides/reactivity.html#runtime-configuration"
href="https://docs.marimo.io/guides/reactivity/#configuring-how-marimo-runs-cells"
target="_blank"
rel="noreferrer"
>
Expand Down
32 changes: 16 additions & 16 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,33 +69,33 @@ markdown_extensions:
nav:
- Marimo: index.md
- Getting Started:
- Overview: getting_started/index.md
- Getting Started: getting_started/index.md
- Installation: getting_started/installation.md
- Quickstart: getting_started/quickstart.md
- Key Concepts: getting_started/key_concepts.md

- User Guide:
- Overview: guides/index.md
- User Guide: guides/index.md
- Running cells: guides/reactivity.md
- Interactive elements: guides/interactivity.md
- Visualizing outputs: guides/outputs.md
- Migrating from Jupyter: guides/coming_from/jupyter.md
- Expensive notebooks: guides/expensive_notebooks.md
- SQL, dataframes, and plots:
- Overview: guides/working_with_data/index.md
- SQL, dataframes, and plots: guides/working_with_data/index.md
- DataFrames: guides/working_with_data/dataframes.md
- SQL: guides/working_with_data/sql.md
- Plotting: guides/working_with_data/plotting.md
- Run notebooks as apps: guides/apps.md
- Run notebooks as scripts: guides/scripts.md
- Testing notebooks:
- Overview: guides/testing/index.md
- Testing notebooks: guides/testing/index.md
- pytest: guides/testing/pytest.md
- doctest: guides/testing/doctest.md
- Export to HTML and other formats: guides/exporting.md
- Run notebooks with WebAssembly: guides/wasm.md
- Deploy notebooks:
- Overview: guides/deploying/index.md
- Deploy notebooks: guides/deploying/index.md
- Authentication: guides/deploying/authentication.md
- Docker: guides/deploying/deploying_docker.md
- HuggingFace: guides/deploying/deploying_hugging_face.md
Expand All @@ -105,33 +105,33 @@ nav:
- Prebuilt containers: guides/deploying/prebuilt_containers.md
- Programmatic: guides/deploying/programmatically.md
- Editor features:
- TODO: guides/editor_features/index.md
- Overview: guides/editor_features/overview.md
- Editor features: guides/editor_features/index.md
- Editor overview: guides/editor_features/overview.md
- AI Completion: guides/editor_features/ai_completion.md
- Hotkeys: guides/editor_features/hotkeys.md
- Package Management: guides/editor_features/package_management.md
- Configuration:
- Overview: guides/configuration/index.md
- Configuration: guides/configuration/index.md
- Runtime configuration: guides/configuration/runtime_configuration.md
- HTML head: guides/configuration/html_head.md
- Theming: guides/configuration/theming.md
- Coming from other tools:
- Overview: guides/coming_from/index.md
- Coming from other tools: guides/coming_from/index.md
- Jupytext: guides/coming_from/jupytext.md
- Papermill: guides/coming_from/papermill.md
- Streamlit: guides/coming_from/streamlit.md
- Extending marimo:
- Overview: guides/integrating_with_marimo/index.md
- Extending marimo: guides/integrating_with_marimo/index.md
- Custom UI plugins: guides/integrating_with_marimo/custom_ui_plugins.md
- Displaying objects: guides/integrating_with_marimo/displaying_objects.md
- Best practices: guides/best_practices.md
- Troubleshooting: guides/troubleshooting.md
- Dangerously set state: guides/state.md
- API Reference:
- Overview: api/index.md
- API Reference: api/index.md
- Markdown: api/markdown.md
- Inputs:
- Overview: api/inputs/index.md
- Inputs: api/inputs/index.md
- AnyWidget: api/inputs/anywidget.md
- Array: api/inputs/array.md
- Batch: api/inputs/batch.md
Expand Down Expand Up @@ -163,7 +163,7 @@ nav:
- Text Area: api/inputs/text_area.md
- Control Flow: api/control_flow.md
- Layouts:
- Overview: api/layouts/index.md
- Layouts: api/layouts/index.md
- Accordion: api/layouts/accordion.md
- Callout: api/layouts/callout.md
- Carousel: api/layouts/carousel.md
Expand All @@ -176,7 +176,7 @@ nav:
- Tree: api/layouts/tree.md
- Plotting: api/plotting.md
- Media:
- Overview: api/media/index.md
- Media: api/media/index.md
- Audio: api/media/audio.md
- Download: api/media/download.md
- Image: api/media/image.md
Expand All @@ -201,11 +201,11 @@ nav:
- Islands: guides/island_example.md
- FAQ: faq.md
- Community:
- Overview: community.md
- Community: community.md
- Contributing: https://github.com/marimo-team/marimo/blob/main/CONTRIBUTING.md
- Code of Conduct: https://github.com/marimo-team/marimo/blob/main/CODE_OF_CONDUCT.md
- Integrations:
- Overview: integrations/index.md
- Integrations: integrations/index.md
- BigQuery: integrations/google_cloud_bigquery.md
- Google Cloud Storage: integrations/google_cloud_storage.md
- Google Sheets: integrations/google_sheets.md
Expand Down

0 comments on commit dc8c4f0

Please sign in to comment.