Add more links to the documentation (#3434)

* link to todo example * add links to features * review --------- Co-authored-by: Falko Schindler <falko@zauberzeug.com>
zauberzeug · Aug 5, 2024 · 641199b · 641199b
1 parent b77d9d9
commit 641199b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 16 deletions.
diff --git a/website/documentation/content/project_structure_documentation.py b/website/documentation/content/project_structure_documentation.py
@@ -19,8 +19,10 @@
 
 doc.text('Simple', '''
     For small apps and experiments you can put the tests in a separate file,
-    as we do in the examples [chat-app](https://github.com/zauberzeug/nicegui/tree/main/examples/chat_app)
-    and [authentication](https://github.com/zauberzeug/nicegui/tree/main/examples/authentication).
+    as we do in the examples
+    [Chat App](https://github.com/zauberzeug/nicegui/tree/main/examples/chat_app)
+    [Todo List](https://github.com/zauberzeug/nicegui/tree/main/examples/todo_list/) and
+    [Authentication](https://github.com/zauberzeug/nicegui/tree/main/examples/authentication).
     To properly re-initialize your `main.py` in the tests,
     you place an empty `__init__.py` file next to your code to make it a package
     and use the `module_under_test` marker to automatically reload your main file for each test.

diff --git a/website/main_page.py b/website/main_page.py
@@ -100,34 +100,34 @@ def create() -> None:
         section_heading('Features', 'Code *nicely*')
         with ui.row().classes('w-full text-lg leading-tight grid grid-cols-1 sm:grid-cols-2 xl:grid-cols-3 gap-8'):
             features('swap_horiz', 'Interaction', [
-                'buttons, switches, sliders, inputs, ...',
-                'notifications, dialogs and menus',
-                'interactive images with SVG overlays',
-                'web pages and native window apps',
+                '[buttons, switches, sliders, inputs, ...](/documentation/section_controls)',
+                '[notifications, dialogs and menus](/documentation/section_page_layout)',
+                '[interactive images](/documentation/interactive_image) with SVG overlays',
+                'web pages and [native window apps](/documentation/section_configuration_deployment#native_mode)',
             ])
             features('space_dashboard', 'Layout', [
-                'navigation bars, tabs, panels, ...',
+                '[navigation bars, tabs, panels, ...](/documentation/section_page_layout)',
                 'grouping with rows, columns, grids and cards',
-                'HTML and Markdown elements',
+                '[HTML](/documentation/html) and [Markdown](/documentation/markdown) elements',
                 'flex layout by default',
             ])
             features('insights', 'Visualization', [
-                'charts, diagrams, tables, audio/video',
-                '3D scenes',
-                'straight-forward data binding',
-                'built-in timer for data refresh',
+                '[charts, diagrams, tables](/documentation/section_data_elements), [audio/video](/documentation/section_audiovisual_elements)',
+                '[3D scenes](/documentation/scene)',
+                'straight-forward [data binding](/documentation/section_binding_properties)',
+                'built-in [timer for data refresh](/documentation/timer)',
             ])
             features('brush', 'Styling', [
-                'customizable color themes',
+                'customizable [color themes](/documentation/section_styling_appearance#color_theming)',
                 'custom CSS and classes',
                 'modern look with material design',
                 '[Tailwind CSS](https://tailwindcss.com/) auto-completion',
             ])
             features('source', 'Coding', [
-                'routing for multiple pages',
+                'routing for multiple [pages](/documentation/page)',
                 'auto-reload on code change',
-                'persistent user sessions',
-                'built-in testing framework',
+                'persistent [user sessions](/documentation/storage)',
+                'super nice [testing framework](/documentation/section_testing)',
             ])
             features('anchor', 'Foundation', [
                 'generic [Vue](https://vuejs.org/) to Python bridge',