Open
Conversation
…ine docstring, missing get_schema
Adds docs/scripts/generate_components.py which introspects all 120+ registered DashAI components and writes per-component MDX pages and per-type index pages under docs/docs/components/. All 31 tests pass.
…escaping, YAML quoting, docstring parser - Use inspect.isfunction() instead of callable() in _get_methods to prevent Pydantic ModelMetaclass (SCHEMA) from appearing as a method - Add _format_default() helper that reads 'placeholder' key (DashAI's primary default location) before falling back to 'default' - Update CATEGORY_CONFIG to include GenerativeModel, GenerativeTask, GlobalExplainer, LocalExplainer; remove dead 'explainer' key - Add _escape_table_cell() and apply it to all Markdown table rows to prevent pipe characters from breaking table layout - Quote YAML front matter title and sidebar_label values to handle colons and special characters - Fix _parse_numpy_docstring summary extraction to stop at section underlines even without a preceding blank line - Remove unused seen = set() variable from _get_methods - Update test_render_component_mdx_contains_title to expect quoted YAML title
…ages - Copy all tutorial image folders (upload_dataset, train_model, predict, converter, converter_chain, explorer, generative) to docs/static/img/tutorials/ - Remove docs/static/img/.gitkeep - Add _category_.json for tutorials (position 2) and plugin-development (position 3) - Port 6 RST tutorials to MDX: upload-dataset, train-model, predict, converter, explorer, generative - Port 4 RST plugin guides to MDX: overview, structure, develop, upload - RST dropdowns converted to HTML <details>/<summary> in overview.mdx - :doc: cross-references converted to relative MDX links - .. note:: / .. warning:: converted to Docusaurus admonitions
… verified
Fix MDX syntax errors in generated component pages by escaping curly braces
({/}) and angle brackets (</>) in table cells and method summaries; remove
obsolete Sphinx source/ tree; set onBrokenLinks to 'throw' (build is clean).
…default and _escape_table_cell
All 6 tutorial pages (upload-dataset, train-model, predict, converter, explorer, generative) now use dashed-box JSX placeholders instead of broken image tags. Screenshots can be dropped in later.
- Huey runs as a subprocess in development, thread only in PyInstaller bundle - React frontend served by FastAPI in production, port 3000 in development
Docusaurus handles locale routing automatically; links should not include the locale prefix.
Refines documentation to specify that text classification operates on a single text column and outputs a single categorical label. Updates both English and Spanish descriptions for accuracy and clarity, emphasizing typical NLP applications and model requirements.
…lugins and pull requests
…et(s)' in Spanish translations
Irozuku
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates the documentation system from Sphinx to Docusaurus, updating the documentation structure, build process, and CI workflows accordingly.
Type of Change
Check all that apply like this [x]:
Changes (by file)
docs/Makefile: Removed Sphinx build configuration..github/workflows/docs.yaml: Updated workflow to use Node.js and Yarn for building and deploying Docusaurus documentation.babel.config.js: Added configuration required for Docusaurus.package.json(docs): Added Docusaurus dependencies and build scripts.docs/docs/build/dev-setup.md: Added development environment setup guide.docs/docs/build/migrations.md: Added database migrations documentation.docs/docs/build/contributing.md: Added contributing guidelines.docs/docs/build/plugin-development/: Introduced plugin development documentation and structure.docs/docs/build/**/_category_.json: Added sidebar/category metadata for Docusaurus.Testing (optional)
yarn build).