Skip to content

docs: Edit and cleanup pass - #249

Open
crandmck wants to merge 5 commits into
mainfrom
docs/github-only-class
Open

docs: Edit and cleanup pass#249
crandmck wants to merge 5 commits into
mainfrom
docs/github-only-class

Conversation

@crandmck

Copy link
Copy Markdown
Contributor
  • Use github-only CSS class instead of inline display:none style to hide content in Docusaurus but still display in the GitHub web interface.

crandmck added 3 commits July 23, 2026 13:20
Switches the GitHub-only content divs to class="github-only" (already
defined in opensource.contentauth.org's custom.css) instead of the
style={{display: 'none'}} JSX trick, which only works because it's
invalid CSS on GitHub. The class-based approach is plain HTML and
renders correctly everywhere.
@crandmck
crandmck marked this pull request as ready for review July 29, 2026 20:36
@crandmck
crandmck requested review from gpeacock and tmathern July 29, 2026 20:36
Comment thread docs/embeddable-api.md Outdated
- The application controls its own write pipeline (e.g., a video transcoder or streaming ingest service) and wants to hash the asset during its own write pass rather than having the SDK re-read the finished file.
- The application needs to receive the raw signed manifest bytes and decide where and how to append them as a new chunk, rather than letting the SDK write to a destination path.
- The asset is being produced incrementally, so the application can pass the stream to `update_hash_from_stream()` at the right moment, then call `sign_embeddable()` to get the manifest without a second full read.
- The application produces the asset incrementally, so it can pass the stream to `update_hash_from_stream()` at the right moment, then call `sign_embeddable()` to get the manifest without a second full read.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically the SDK still produces the asset, the SDK is used by an application... I think the previous wording was more correct.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC, the action originates in the application, which then uses the SDK to produce the asset.

I changed it to "Using the SDK, the application produces the asset incrementally..."

Active voice is better in most cases.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants