Skip to content

Commit 1de0820

Browse files
committed
update README
1 parent 5af64e1 commit 1de0820

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This repository provides comprehensive Pinecone documentation organized into the
1515
- **PINECONE-typescript.md** - TypeScript/Node.js SDK guide with code examples
1616
- **PINECONE-go.md** - Go SDK guide with code examples
1717
- **PINECONE-java.md** - Java SDK guide with code examples
18+
- **PINECONE-troubleshooting.md** - Common issues, solutions, and debugging tips
1819

1920
## Quick Start
2021

@@ -81,15 +82,16 @@ After running the commands above, you should have:
8182

8283
```
8384
your-project/
84-
├── .agents/ # Agent documentation folder
85-
│ ├── PINECONE.md # Main universal guide
86-
│ ├── PINECONE-quickstart.md # Quickstart tutorials
87-
│ ├── PINECONE-cli.md # CLI documentation
88-
│ ├── PINECONE-python.md # Python SDK guide
89-
│ ├── PINECONE-typescript.md # TypeScript/Node.js SDK guide
90-
│ ├── PINECONE-go.md # Go SDK guide
91-
│ └── PINECONE-java.md # Java SDK guide
92-
└── AGENTS.md # Your project's agent guide (with Pinecone section)
85+
├── .agents/ # Agent documentation folder
86+
│ ├── PINECONE.md # Main universal guide
87+
│ ├── PINECONE-quickstart.md # Quickstart tutorials
88+
│ ├── PINECONE-cli.md # CLI documentation
89+
│ ├── PINECONE-python.md # Python SDK guide
90+
│ ├── PINECONE-typescript.md # TypeScript/Node.js SDK guide
91+
│ ├── PINECONE-go.md # Go SDK guide
92+
│ ├── PINECONE-java.md # Java SDK guide
93+
│ └── PINECONE-troubleshooting.md # Troubleshooting guide
94+
└── AGENTS.md # Your project's agent guide (with Pinecone section)
9395
9496
```
9597

@@ -157,7 +159,7 @@ The workflow triggers automatically on tag push (`push: tags: v*`) and:
157159
- If a release exists → uses that release and attaches assets
158160
- If no release exists → creates a new release automatically
159161
3. Packages the following files:
160-
- All files from `.agents/` folder (7 Pinecone documentation files)
162+
- All files from `.agents/` folder (8 Pinecone documentation files)
161163
- `AGENTS-pinecone-snippet.md` file
162164
4. Creates archives with the structure:
163165
```
@@ -169,7 +171,8 @@ The workflow triggers automatically on tag push (`push: tags: v*`) and:
169171
│ ├── PINECONE-python.md
170172
│ ├── PINECONE-typescript.md
171173
│ ├── PINECONE-go.md
172-
│ └── PINECONE-java.md
174+
│ ├── PINECONE-java.md
175+
│ └── PINECONE-troubleshooting.md
173176
└── AGENTS-pinecone-snippet.md
174177
```
175178
5. Uploads both `agents.zip` and `agents.tar.gz` to the release

0 commit comments

Comments
 (0)