diff --git a/README.md b/README.md index 18fe620..a69506f 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,10 @@ My portfolio website as a web developer. ## Notes -This project is built with [Remix Run](https://remix.run/) and was started using the [Epic Stack](https://github.com/epicweb-dev/epic-stack), graciously provided by [Kent C. Dodds](https://twitter.com/kentcdodds). +This project is built with [Remix Run](https://remix.run/) and was started using the [Epic Stack](https://github.com/epicweb-dev/epic-stack), graciously maintained by [Kent C. Dodds](https://twitter.com/kentcdodds). ## Docs Please [read the Docs](./docs/README.md) for more information. + +Please [read the Roadmap](./docs/roadmap.md) for a list of features and improvements planned for the project. \ No newline at end of file diff --git a/docs/decisions/003-one-user.md b/docs/decisions/003-one-user.md index e450e35..67077cf 100644 --- a/docs/decisions/003-one-user.md +++ b/docs/decisions/003-one-user.md @@ -28,4 +28,4 @@ Implement a single-user system with the following characteristics: ## Links -* [Authentication in Epic Stack](https://github.com/epicweb-dev/epic-stack/blob/main/docs/authentication.md) \ No newline at end of file +* [Authentication in Epic Stack](https://github.com/epicweb-dev/epic-stack/blob/main/docs/authentication.md) diff --git a/prompts/README.md b/prompts/README.md new file mode 100644 index 0000000..5da3b01 --- /dev/null +++ b/prompts/README.md @@ -0,0 +1,11 @@ +# Prompt Engineering Documentation + +This directory contains comprehensive documentation and resources for prompt engineering. It is designed to help developers and AI practitioners create, refine, and optimize prompts for various AI models. The documentation includes best practices, examples, and guidelines to ensure effective and efficient prompt engineering. + +## Contents + +- **Introduction**: Overview of prompt engineering and its importance. +- **Best Practices**: Guidelines and tips for creating effective prompts. +- **Examples**: Sample prompts for different use cases. +- **Tools and Resources**: Recommended tools and additional resources for prompt engineering. +- **FAQ**: Frequently asked questions and troubleshooting tips. diff --git a/prompts/routes.md b/prompts/routes.md new file mode 100644 index 0000000..04770a6 --- /dev/null +++ b/prompts/routes.md @@ -0,0 +1,36 @@ +# Routes Documentation + +## Excluding Routes from Sitemap + +In some cases, you might want to exclude certain routes from being included in your sitemap. This can be useful for routes that contain sensitive information, admin pages, or any other pages that you do not want to be indexed by search engines. + +### Example + +Consider the following route configuration for a profile settings page: + +```typescript +typescript:app/routes/settings+/profile.tsx +export const handle: BreadcrumbHandle & SEOHandle = { +breadcrumb: Edit Profile, +getSitemapEntries: () => null, // Exclude this route from the sitemap +} +``` + +### Steps to Exclude a Route + +1. **Define the `handle` Object**: Ensure your route file exports a `handle` object that implements the `SEOHandle` interface. +2. **Set `getSitemapEntries` to `null`**: Within the `handle` object, set the `getSitemapEntries` function to return `null`. + +### Full Example + +Here is a complete example of a route file that excludes itself from the sitemap: + +```typescript:app/routes/settings+/profile.tsx +import { Icon } from 'some-icon-library'; +import { BreadcrumbHandle, SEOHandle } from 'some-seo-library'; + +export const handle: BreadcrumbHandle & SEOHandle = { + breadcrumb: Edit Profile, + getSitemapEntries: () => null, // Exclude this route from the sitemap +} +```