sebnitu / vrembem / 24937162532

91%

main: 100%

push

github

Improve the Vrembem docs Astro theme (#2781)

This PR primarily refactors redundant elements of the documentation astro theme. The main improvement has been refactoring the `Page.astro` layout to be a more robust in rendering both collections and static pages. This removed a lot of redundancy in the dynamic route template for page, package and module collections.

With better support of collections and shared layout, this PR creates the `pages` collection along with the initial structure of upcoming documentation pages under the `guide` root path.

**Additional changes**

- `utility`: Moved spacing above the margin import so that margin utilities can now override spacing provided by a parent.
- `docs`: The card component has been removed since it wasn't used.
- `docs`: A new `CategoryIcon` component has been added to handle mapping and rendering category icons along with an optional tooltip to display the category name.
- `docs`: Install the types for feather-icons and fix icon type errors.
- `docs`: Added a TypeScript alias for the src directory `@/` and applied throughout to reduce the use of `../../` etc.
- `docs`: Added a new `ModulesMenu` for rendering a menu for a modules collection.
- `docs`: Added a new `getCollectionPath` helper for returning the path of a given collection.
- `docs`: Added a new `getModuleMeta` helper for returning the meta information of a module. This replaced the need to explicitly set the `parent` and `group` properties of a module in favor of a file based system.
- `docs`: Added a new `sortCollectionBy` helpers module that exports `{ byCategory, byOrder, byTitle }`. This replaced the need for separate `get[collection]` handling and is more precise about when and how collections are sorted.
- `docs`: Added a new `filterCollection` helper that ensures the correct groups of collections are returned. This handles things like returning modules based on current parent/group and pages based on their root path.
- `docs`: Refacto... (continued)

565 of 647 branches covered (87.33%)

Branch coverage included in aggregate %.

882 of 948 relevant lines covered (93.04%)

32.09 hits per line