Skip to content

Commit 927d5ad

Browse files
Refactor contributing guidelines and FAQ automation
Removed outdated contribution methods and FAQ automation details.
1 parent bdcdc82 commit 927d5ad

File tree

1 file changed

+1
-103
lines changed

1 file changed

+1
-103
lines changed

README.md

Lines changed: 1 addition & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A static site generator for DataTalks.Club course FAQs with automated AI-powered
1212
## Project Structure
1313

1414
```
15-
datatalksclub-faq/
15+
faq/
1616
├── _questions/ # FAQ content organized by course
1717
│ ├── machine-learning-zoomcamp/
1818
│ │ ├── _metadata.yaml # Course configuration
@@ -38,73 +38,8 @@ datatalksclub-faq/
3838

3939
## Contributing FAQ Entries
4040

41-
We welcome FAQ contributions! There are two ways to contribute:
42-
43-
### 1. Automated (Recommended)
44-
45-
Simply [create a new issue](https://github.com/DataTalksClub/faq/issues/new?template=faq-proposal.yml) using the "FAQ Proposal" template. Our FAQ Bot will:
46-
47-
1. Analyze your proposal against existing FAQs
48-
2. Decide the best action (NEW, UPDATE, or DUPLICATE)
49-
3. Either create a PR with your changes or provide feedback
50-
5141
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed instructions.
5242

53-
### 2. Manual Pull Request
54-
55-
1. Fork this repository
56-
2. Add/modify FAQ files in `_questions/{course}/{section}/`
57-
3. Follow the frontmatter format (see below)
58-
4. Create a Pull Request
59-
60-
## FAQ File Format
61-
62-
Each FAQ entry is a markdown file with YAML frontmatter:
63-
64-
```markdown
65-
---
66-
id: abc1234567
67-
question: 'How do I install the dependencies?'
68-
sort_order: 10
69-
---
70-
71-
Your answer content here.
72-
```
73-
74-
### Frontmatter Fields
75-
76-
- **id**: Unique 10-character identifier (auto-generated)
77-
- **question**: The FAQ question text
78-
- **sort_order**: Integer controlling order within section
79-
- **images** (optional): Array of image metadata for embedded images
80-
81-
## FAQ Automation
82-
83-
The FAQ automation system uses:
84-
85-
- **minsearch**: Lightweight text search to find similar existing FAQs
86-
- **OpenAI GPT-5**: LLM-based decision making for triage
87-
- **Pydantic**: Structured output validation
88-
- **GitHub Actions**: Automated workflow orchestration
89-
90-
### How It Works
91-
92-
1. **Proposal Submission**: User creates GitHub issue with FAQ proposal
93-
2. **Retrieval**: System searches existing FAQs for similar content
94-
3. **LLM Analysis**: GPT-5 analyzes proposal + search results and decides:
95-
- **NEW**: Question not covered → create new FAQ file
96-
- **UPDATE**: Adds valuable context → merge with existing FAQ
97-
- **DUPLICATE**: Already fully answered → close with explanation
98-
4. **Action Execution**:
99-
- NEW/UPDATE: Create PR with file changes (issue auto-closes when PR is merged)
100-
- DUPLICATE: Comment on issue and close immediately
101-
102-
### Configuration
103-
104-
The workflow requires:
105-
106-
- **OPENAI_API_KEY**: Set as repository secret for GitHub Actions
107-
- **GitHub permissions**: `contents: write`, `issues: write`, `pull-requests: write`
10843

10944
## Development
11045

@@ -189,40 +124,3 @@ See [testing documentation](tests/README.md) for detailed information about the
189124
- Applies Jinja2 templates
190125
- Generates course pages and index
191126
- Copies assets to `_site/`
192-
193-
### FAQ Automation Pipeline
194-
195-
1. **Issue Parsing**: Extract question/answer from GitHub issue
196-
2. **Index Building**: Create search index from existing FAQs
197-
3. **Retrieval**: Find top 5 similar FAQs
198-
4. **LLM Decision**: GPT-5 analyzes and decides action
199-
5. **Execution**: Create PR or comment based on decision
200-
201-
## Dependencies
202-
203-
### Core
204-
- **jinja2**: Template rendering
205-
- **mistune**: Markdown parsing
206-
- **pygments**: Syntax highlighting
207-
- **pyyaml**: YAML parsing
208-
209-
### Automation
210-
- **minsearch**: FAQ search/retrieval
211-
- **openai**: LLM integration
212-
- **pydantic**: Data validation
213-
214-
### Development
215-
- **pytest**: Testing framework
216-
217-
## License
218-
219-
[Add license information]
220-
221-
## Support
222-
223-
- **Issues**: Report bugs or request features via [GitHub Issues](https://github.com/DataTalksClub/faq/issues)
224-
- **Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md)
225-
226-
## Acknowledgments
227-
228-
Built with ❤️ for the DataTalks.Club community.

0 commit comments

Comments
 (0)