Goals
The FAQ has already been bundled with the DC client under the Settings → Help menu.
It would be beneficial to include further docs to help a user troubleshoot more issues. It could be either bundled in the DC client, or shipped as a separate webxdc.
Maintenance
To ensure long term maintainability, it ought to be built automatically from the sources, not by hand, in order for it to assimilate upstream updates.
Features
- efficient storage
- rendering of rich content
- rewrite those external links to internal ones whose target is included in the bundle
- follow internal links
- tabbed browsing
- bookmarking articles and sections
- ranked fuzzy search observing synonyms with context enriched from parents and weighted siblings
- show a deep link to the respective original source page to enable providing a correction upstream
- also usable outside Delta Chat, rendered on a static VCS page (ideally as a single page app that can be saved as a file with a single click)
- include the internationalized versions of content that already exists
Sources
- GitHub - chatmail/provider-db: Database of Email Providers and how well they work with chatmail · GitHub
- Summary of the content of any required external webpage that describes how to configure a given provider if it does not work out of the box and the existing provider note would not be sufficient
- Forum posts, or at least the topics which were solved successfully
- relay/doc at main · chatmail/relay · GitHub
- the complete changelog and commit messages from all related software
- GitHub issues and comments for all related software
- GitHub - deltachat/deltachat-pages: Delta Chat Website · GitHub
- posts from DC-adjacent Fediverse accounts