Skip to content

Commit

Permalink
removed tutorials section, preferring to link to implementation speci…
Browse files Browse the repository at this point in the history
…fic content
  • Loading branch information
akollegger committed Nov 29, 2024
1 parent b093dd7 commit 225824c
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 91 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,13 @@ Consider this priority order of contribution:
- for example, how to perform vector similarity search
- add a page under `/src/content/docs/guides`
- use the template `/src/content/docs/guides/template.md`
4. Tutorial - some how-to guides can be combined into tutorials
- walk through a complete example, including data
- still try to be implementation independent
- for example, chat with a PDF
- add a page under `/src/content/docs/tutorials`
- use the template `/src/content/docs/tutorials/template.md`
4. ~~Tutorial - some how-to guides can be combined into tutorials~~
- prefer to reference/link to tutorials where appropriate and available
- ~~walk through a complete example, including data~~
- ~~still try to be implementation independent~~
- ~~for example, chat with a PDF~~
- ~~add a page under `/src/content/docs/tutorials`~~
- ~~use the template `/src/content/docs/tutorials/template.md`~~


### Media assets
Expand Down
10 changes: 1 addition & 9 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,6 @@ export default defineConfig({
label: 'Intro to Knowledge Graphs',
link: '/concepts/intro-to-knowledge-graphs/'
}]
}, {
label: 'Tutorials',
items: [
// Each item here is one entry in the navigation menu.
{
label: 'Chat with a PDF',
link: '/tutorials/chat-with-pdf/'
}]
}, {
label: 'How-to Guides',
items: [{
Expand All @@ -60,7 +52,7 @@ export default defineConfig({
}, {
label: 'Reference',
items: [{
label: 'Retrieval Patterns',
label: 'Retrieval',
autogenerate: {
directory: 'reference/graphrag'
}
Expand Down
5 changes: 0 additions & 5 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,6 @@ import { LinkCard, CardGrid } from '@astrojs/starlight/components';
description="Goal focused guides, from data preparation to retrieval."
href="/guides/chunking"
/>
<LinkCard
title="Tutorials"
description="Put everything together using real data."
href="/tutorials/chat-with-pdf"
/>
<LinkCard
title="Reference"
description="GraphRAG Pattern Catalog of graph models and GraphRAG retrievers"
Expand Down
11 changes: 0 additions & 11 deletions src/content/docs/tutorials/chat-with-pdf.md

This file was deleted.

17 changes: 0 additions & 17 deletions src/content/docs/tutorials/index.md

This file was deleted.

43 changes: 0 additions & 43 deletions src/content/docs/tutorials/template.md

This file was deleted.

0 comments on commit 225824c

Please sign in to comment.