Skip to content

Commit

Permalink
more docs: one user, roadmap, prompt files started
Browse files Browse the repository at this point in the history
  • Loading branch information
goodeats committed Aug 27, 2024
1 parent 2b58329 commit 120adc9
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/decisions/003-one-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
* [Authentication in Epic Stack](https://github.com/epicweb-dev/epic-stack/blob/main/docs/authentication.md)
11 changes: 11 additions & 0 deletions prompts/README.md
Original file line number Diff line number Diff line change
@@ -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.
36 changes: 36 additions & 0 deletions prompts/routes.md
Original file line number Diff line number Diff line change
@@ -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: <Icon name="file-text">Edit Profile</Icon>,
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: <Icon name="file-text">Edit Profile</Icon>,
getSitemapEntries: () => null, // Exclude this route from the sitemap
}
```

0 comments on commit 120adc9

Please sign in to comment.