Describe how this project works and is organized && centralize documentation on website #825
Closed
0 of 1 issue completed
Description
Describe how this project works and is organized on website
- why does it need description and is not intuitive? rather fix that?!
- extend "how it works" page
- link to this project board
- remove contents from project READMEs
/
├── index.md (Home Page)
├── about.md (About html2rss, project goals, philosophy)
├── getting-started/
│ ├── index.md (Overview, quick start guide)
│ ├── installation.md (How to install)
│ ├── basic-usage.md (First RSS feed, simple example)
│ └── advanced-topics.md (More complex scenarios, custom configurations)
├── recipes/
│ ├── index.md (Collection of common use cases/examples)
│ ├── website-a-feed.md (Example: Creating a feed from Website A)
│ ├── website-b-feed.md (Example: Creating a feed from Website B)
│ └── ... (More specific examples)
├── configuration/
│ ├── index.md (Overview of configuration options)
│ ├── selectors.md (CSS selectors explained)
│ ├── attributes.md (Extracting attributes)
│ ├── parsing-modes.md (Different parsing modes)
│ └── ... (Other config details)
├── troubleshooting.md (FAQ, common errors, debugging tips)
├── contributing.md (How to contribute to the project/docs)
├── api-reference.md (Detailed API/CLI reference - if applicable)
└── contact.md (How to get in touch)