organicmaps / organicmaps/website
Add /faq/ section
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 36
- Forks
- 44
- Avg merge
- 6h 50m
- Merged PRs (30d)
- 4
Description
A taxonomy should be enabled to enable content categorization not only for faq but also for the news section and other future sections.
Each FAQ question + answer should have a separate markdown page for easier translation.
The root faq section should be an index page that combines all individual faq pages and groups them by the taxonomy (or maybe we need manual subcategories?).
Initial content can be taken from the organicmaps repo in data/faq.html.
An important new section is TTS instructions, there's unfinished #32 about it. For reference:
https://mapsme.zendesk.com/hc/en-us/articles/208628985-How-can-I-check-TTS-settings-on-my-Android-device-
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing website section and taxonomy structure, then inspect data/faq.html in the Organic Maps repository and the unfinished #32 issue for source content and TTS requirements. Done means the FAQ has separate translatable Markdown pages, a root index grouped by taxonomy, and the initial FAQ and TTS content is included.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100