-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
more docs: one user, roadmap, prompt files started
- Loading branch information
Showing
4 changed files
with
51 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
} | ||
``` |