WICG / WICG/webpackage

Improving instructions for generating bundle from local directory

Open
#792 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

go
Dominant language
Go
Stars
1.3k
Forks
125
PR merge metrics
No merged PRs in 30d

Description

Referring to instructions at https://github.com/WICG/webpackage/blob/main/go/bundle/README.md#from-a-local-directory (Usage -> From a local directory section)

Bundles are either standalone for opening in a browser as a page, or used in subresource loading with WebBundles (https://chromestatus.com/feature/5710618575241216).
The latter is accomplished by omitting the -baseURL flag. It is correctly stated this makes the bundle relative, but it is not clear it also means such a bundle can't be opened as a page (I usually prefer relative paths over absolute ones).

See related discussion here https://bugs.chromium.org/p/chromium/issues/detail?id=1352933#c3

So I propose:
The -baseURL flag is mandatory for creating standalone bundles, which can be opened in a browser. The value can be arbitrary, but keep in mind it becomes the part of the URL shown in the address bar. It has to contain the trailing slash.
Skip -baseURL for bundles used in subresource loading.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open go/bundle/README.md and read the Usage -> From a local directory section, along with the linked WebBundles context. Update the instructions to distinguish standalone bundles, which require a trailing-slash -baseURL, from bundles for subresource loading, which omit it; done means the two uses and browser-opening limitation are explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.