Skip to content

Commit 773372c

Browse files
committed
technical documentation
1 parent a9ccf9e commit 773372c

2 files changed

Lines changed: 1 addition & 29 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,7 @@ Before adding feeds to the Excel file, gather the following information:
3838
**Required Information:**
3939
- **RSS/Atom Feed URL**: The direct link to the XML feed (usually ends in `.xml`, `.rss`, or `/feed`)
4040
- **Blog/Site Title**: The official name of the blog or publication
41-
- **Category**: Which category best fits this feed (see [Category Guidelines](#category-guidelines))
42-
43-
**Optional Information:**
44-
- **Website URL**: The main homepage of the blog
45-
- **Description**: Brief note about the content focus
41+
- **Category**: Which category best fits this feed
4642

4743
**How to Find RSS Feeds:**
4844
- Look for RSS icons (📡) on websites

README.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -139,30 +139,6 @@ rss_cse_setup/
139139
- **Data Processing**: Node.js, xlsx library
140140
- **Icons**: React Icons
141141

142-
## FAQ & Troubleshooting
143-
144-
### Common Issues
145-
146-
**Q: The OPML file won't import into my RSS reader**
147-
- Ensure you're using the "Import OPML" feature, not "Add feed"
148-
- Try downloading the file again if it appears corrupted
149-
- Some readers require the file extension to be `.opml`
150-
151-
**Q: I don't see new feeds after adding them**
152-
- Make sure you ran `node convertExcelToJson.js` after editing the Excel file
153-
- Check that the Excel file follows the required column format
154-
- Refresh the web page to see updated feeds
155-
156-
**Q: A feed isn't working**
157-
- Verify the RSS/Atom URL is correct and accessible
158-
- Some feeds may be temporarily down
159-
- Check if the feed requires authentication or has changed URLs
160-
161-
**Q: How do I suggest a new category?**
162-
- Open an issue on GitHub with your category suggestion
163-
- Include at least 5-10 quality feeds for the new category
164-
- Explain why this category would benefit the community
165-
166142
### Getting Help
167143

168144
- 📝 [Open an issue](../../issues) for bugs or feature requests

0 commit comments

Comments
 (0)