Skip to content

docs: add initial Jupyter Book documentation scaffold - #322

Closed
yukthagangadhari5 wants to merge 3 commits into
mllam:mainfrom
yukthagangadhari5:docs-jupyterbook-scaffold
Closed

docs: add initial Jupyter Book documentation scaffold#322
yukthagangadhari5 wants to merge 3 commits into
mllam:mainfrom
yukthagangadhari5:docs-jupyterbook-scaffold

Conversation

@yukthagangadhari5

Copy link
Copy Markdown

Describe your changes

This PR introduces an initial Jupyter Book scaffold to structure project documentation.

Specifically, it adds:

_config.yml for Jupyter Book configuration

_toc.yml to define documentation structure

index.md as the documentation landing page

quickstart.md with a minimal usage example for metrics

The goal is to establish a foundation for structured documentation generation, aligned with the discussion in Issue #61 regarding automated documentation workflows.

This PR does not modify existing source code.

Issue Link

Related to #61

Type of change

🐛 Bug fix

✨ New feature

💥 Breaking change

📖 Documentation

Checklist before requesting a review

My branch is up-to-date with the target branch

I have performed a self-review of my changes

I have updated the README (not required for this scaffold PR)

I have added tests (not applicable – documentation change)

You do NOT need to fill reviewer/assignee checklist — that’s for maintainers.

@sadamov

sadamov commented Mar 3, 2026

Copy link
Copy Markdown
Collaborator

please add your input to this PR instead: #196 edit: #272 and #252

@sadamov sadamov closed this Mar 3, 2026
@sadamov sadamov added the duplicate This issue or pull request already exists label Mar 3, 2026
@yukthagangadhari5

Copy link
Copy Markdown
Author

Hi! I had opened PR #322 proposing a small Jupyter Book documentation scaffold (index, quickstart, config, toc), but it was closed with the suggestion to contribute here instead.

I'd be happy to integrate those changes into this PR if they are useful. The goal was mainly to provide a minimal Quickstart page and documentation structure aligned with the Jupyter Book direction discussed in Issue #61.

Please let me know if you'd like me to adapt the changes to match the structure in this PR.

@joeloskarsson

Copy link
Copy Markdown
Collaborator

I think we are trying to focus these efforts on PRs #252 and #272 now. Please discuss and try to contribute there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

duplicate This issue or pull request already exists

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants