Skip to content

Commit

Permalink
Three simple suggestions to improve docs. (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandercerutti authored Apr 18, 2023
2 parents 6a4d425 + 2bec667 commit 7974fc9
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ sub37 is set of client-side _dependency-free_ libraries that aims to provide a c

sub37 architecture is made of three components:

- A Renderer (`@sub37/captions-renderer`), a WebComponent that handles all the aspects of captions rendering (styles, colors, positioning, etc.);
- A Server (`@sub37/server`), a client library that handles timed serving of cues and centralizes all the shared aspects (formats, communication);
- An Adapter (e.g. `@sub37/webvtt-adapter`), a library that knows how to parse a specific captions format and knows how to convert it to the core format provided by the server;
- A [Renderer](packages/captions-renderer/) (`@sub37/captions-renderer`), a WebComponent that handles all the aspects of captions rendering (styles, colors, positioning, etc.);
- A [Server](packages/server/) (`@sub37/server`), a client library that handles timed serving of cues and centralizes all the shared aspects (formats, communication);
- An [Adapter](packages/webvtt-adapter/) (e.g. `@sub37/webvtt-adapter`), a library that knows how to parse a specific captions format and knows how to convert it to the core format provided by the server;

Of the three components, both Renderer and Adapter are replaceable: they only need to provide the correct support to the interface that server expects to use to communicate with them (see the wiki).

Expand Down
2 changes: 1 addition & 1 deletion packages/server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ Hey mom, look at me, I'm having fun!

## Error handling

All `sub37` are studied to be as safe as possible and with parlant errors when they get thrown. All errors exposed, can be used through the `Errors` namespace imported as above.
All `sub37` functions are as safe as possible and, when things go wrong, throw explicative errors so that issues can be diagnosed easily. All the exposed errors can be used importing the `Errors` namespace as shown below.

```typescript
try {
Expand Down
2 changes: 1 addition & 1 deletion packages/webvtt-adapter/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @sub37/webvtt-adapter

As its name says, this renderer handles whatever concerns the parsing, the tokenization and hence the conversion of a WebVTT text track so that it can be used by `@sub37/*`.
As its name says, this adapter handles whatever concerns the parsing, the tokenization and hence the conversion of a WebVTT text track so that it can be used by `@sub37/*`.

It tries to adhere as much as possible to the standard, leaving out or manipulating some concepts regarding the rendering of cues (which must be accomplished along with `@sub37/captions-renderer`).

Expand Down

1 comment on commit 7974fc9

@vercel
Copy link

@vercel vercel bot commented on 7974fc9 Apr 18, 2023

Choose a reason for hiding this comment

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

Please sign in to comment.