Document hosting multiple local BlobDirs

[Mirochill]

Summary

• clarify that blobtools host serves the parent directory containing one or more BlobDirs
• document the /view/all URL used to browse locally hosted datasets
• add a Docker example that mounts the datasets parent directory and hosts it

Fixes #278

Validation

• Not run locally
• Static validation only: git diff --check, git diff --cached --check, git show --stat --oneline --check HEAD

Summary by Sourcery

Document how to host one or multiple local BlobDirs with blobtools host and clarify the expected directory layout and access URLs.

Documentation:

• Expand local hosting documentation to explain hosting parent directories containing one or more BlobDirs, including example directory structures and URLs.
• Document use of the /view/all route for browsing locally hosted datasets and add a Docker-based hosting example.
• Update quick-start docs to reference hosting the datasets parent directory and link to detailed local hosting guidance.

[sourcery-ai]

Reviewer's Guide

Updates the local hosting documentation to clarify that blobtools host expects a parent directory containing one or more BlobDirs, documents the /view/all browsing endpoint, and adds examples (including Docker) for hosting single or multiple local datasets from a shared parent directory.

Flow diagram for hosting multiple BlobDirs with blobtools host

flowchart LR
    User((User)) -->|runs| BlobtoolsHost
    subgraph LocalFilesystem
        DatasetsDir[/datasets parent directory/]
        BlobDir1[example-1 BlobDir]
        BlobDir2[example-2 BlobDir]
        DatasetsDir --> BlobDir1
        DatasetsDir --> BlobDir2
    end

    BlobtoolsHost[blobtools host --api-port 8000 --port 8080 /path/to/datasets] --> DatasetsDir
    Browser[Web browser] -->|open /view/all| BlobtoolsHost
    Browser -->|open /view/all/dataset/example-1| BlobtoolsHost

    subgraph DockerContainer
        DockerBlobtools[blobtools host /blobtoolkit/datasets]
    end

    User -->|runs docker run -v $PWD/datasets:/blobtoolkit/datasets| DockerBlobtools
    DockerBlobtools --> DatasetsDir

Loading

File-Level Changes

Change	Details	Files
Clarify directory layout and hosting behavior for single and multiple local BlobDirs, including new /view/all usage and Docker example.	Explain that blobtools host expects a directory containing one or more BlobDirs rather than a single BlobDir path. Provide a concrete example of hosting a single BlobDir by passing its parent directory and show the expected on-disk layout. Introduce a new section on hosting multiple BlobDirs from a common parent directory, including example directory tree and command invocation with explicit API and UI ports. Document the /view/all URL for listing datasets and provide an example of directly opening a specific dataset URL. Add a Docker-based example that mounts the datasets parent directory into the container and runs blobtools host against that mounted path. Update port configuration examples to consistently reference the parent datasets directory.	docs/viewer/local-hosting.md
Align quick-start viewer documentation with the clarified parent-directory hosting model and /view/all entrypoint.	Update quick-start instructions to describe hosting the parent directory containing one or more BlobDirs instead of a single BlobDir. Adjust the example host command to use a generic /path/to/datasets/ path. Change the browser entrypoint from the root URL to /view/all and link to the Local Hosting page for directory layout and Docker usage details.	docs/viewer/index.md

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#278	Document how to host multiple local BlobDir datasets by specifying the correct parent directory structure for blobtools host.	✅
#278	Clarify how to access locally hosted datasets in the browser (including the /view/all URL) and provide a working Docker example for hosting multiple datasets.	✅

Possibly linked issues

• mulitple datasets #278: PR updates local-hosting docs, directory layout, Docker command, and /view/all URL exactly matching the issue’s question.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.