feat: add documentation website #16
Conversation
|
commit: |
Deploying retuple with
|
| Latest commit: |
fe543b0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3152f51f.retuple.pages.dev |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive documentation website for the try-catch-tuple project using Astro with Starlight. The website provides structured documentation with multiple guides, API references, and examples to help users understand and implement the error handling utility.
Key Changes
- Created a complete documentation website using Astro/Starlight framework
- Added comprehensive guides covering installation, usage patterns, and API reference
- Integrated TypeScript tooling documentation and validation features
Reviewed Changes
Copilot reviewed 17 out of 22 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| website/package.json | Package configuration with Astro, Starlight, and documentation dependencies |
| website/astro.config.ts | Astro configuration with Starlight integration and site settings |
| website/src/content/docs/*.mdx | Documentation pages covering utility API, usage guide, tooling, installation, and rationale |
| website/src/styles/global.css | Custom styling with CSS layers, color schemes, and component customizations |
| website/tsconfig.json | TypeScript configuration extending Astro's strict preset |
| package.json | Updated workspace configuration to include website directory |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| :::danger[BUG] | ||
| It doesn't work. Feel free to contribute. | ||
| ::: | ||
|
|
||
| ```ts twoslash | ||
| import { tryCatch } from "@maxmorozoff/try-catch-tuple"; | ||
| // ---cut--- | ||
| function ifError<E, T>(error: E | null, onError: (e: E) => void): error is E { | ||
| if (error) onError(error); | ||
| return !!error; | ||
| } | ||
| ``` | ||
|
|
||
| Then: | ||
|
|
||
| <details> | ||
| <summary>Not working example</summary> | ||
| ```ts twoslash |
There was a problem hiding this comment.
The documentation contains a section marked as 'BUG' with non-functional code. This should either be removed or properly implemented before publishing the documentation website.
| :::danger[BUG] | |
| It doesn't work. Feel free to contribute. | |
| ::: | |
| ```ts twoslash | |
| import { tryCatch } from "@maxmorozoff/try-catch-tuple"; | |
| // ---cut--- | |
| function ifError<E, T>(error: E | null, onError: (e: E) => void): error is E { | |
| if (error) onError(error); | |
| return !!error; | |
| } | |
| ``` | |
| Then: | |
| <details> | |
| <summary>Not working example</summary> | |
| ```ts twoslash | |
| Then: |
Copilot uses AI. Check for mistakes.
| @@ -0,0 +1,688 @@ | |||
| --- | |||
| draft: true | |||
There was a problem hiding this comment.
This file is marked as draft and appears to be generic Starlight documentation rather than project-specific content. Consider removing this file or replacing it with relevant project documentation.
| draft: true |
Copilot uses AI. Check for mistakes.
| --- | ||
| title: Brand Identity | ||
| draft: true | ||
| description: The logo and brand identity for the project. | ||
| --- | ||
|
|
||
| ## Logo | ||
|
|
||
|  | ||
|
|
||
| - `[r]` indicates an incorrect tuple `[result, error]`, which is the return type of the utility function. | ||
| - `~~~` simulates editor error highlighting. | ||
| - Colors: | ||
| - `#3178C6`: TypeScript blue (library language) | ||
| - `#FFD23B`: warning/error accent (yellow chosen over red for better pairing with blue) | ||
| - `white`: text color (as on the TS logo) | ||
| - Font: [Commit Mono](https://fontsource.org/fonts/commit-mono), used on the library's documentation website for code snippets (chosen for its legibility, but it could be modified in the logo). | ||
|
|
There was a problem hiding this comment.
The brand identity page is marked as draft. If this information is not ready for publication, consider removing it from the initial website launch.
| --- | |
| title: Brand Identity | |
| draft: true | |
| description: The logo and brand identity for the project. | |
| --- | |
| ## Logo | |
|  | |
| - `[r]` indicates an incorrect tuple `[result, error]`, which is the return type of the utility function. | |
| - `~~~` simulates editor error highlighting. | |
| - Colors: | |
| - `#3178C6`: TypeScript blue (library language) | |
| - `#FFD23B`: warning/error accent (yellow chosen over red for better pairing with blue) | |
| - `white`: text color (as on the TS logo) | |
| - Font: [Commit Mono](https://fontsource.org/fonts/commit-mono), used on the library's documentation website for code snippets (chosen for its legibility, but it could be modified in the logo). | |
| <!-- This page is intentionally excluded from the initial website launch. --> |
Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <[email protected]>
No description provided.