Welcome to the official documentation repository for Artado Search! This repository contains all the information you need to understand, use, and contribute to Artado Search, a privacy-focused, open-source search engine. Whether you're a user, developer, or contributor, you'll find valuable resources here.
This repository serves as the central hub for all documentation related to Artado Search. Over time, the content here will be migrated to our upcoming documentation website, which will be built using DokuWiki. Until then, this repo will be the primary source of information.
The documentation is organized into several key sections:
- Getting Started: Basic instructions to help users set up and start using Artado Search.
- User Guide: Detailed information on using Artado Search, including features, tips, and best practices.
- Developer Guide: Resources for developers looking to contribute to the project, including setup instructions, coding standards, and API documentation.
- FAQ: Frequently asked questions and their answers.
We welcome and appreciate contributions to improve the documentation. If you spot any errors, have suggestions for new content, or want to help with the migration to DokuWiki, your help is invaluable. Here’s how you can contribute:
- Report Issues: If you find mistakes or unclear content, please open an issue to let us know.
- Submit Pull Requests: If you have improvements or new content to add, feel free to submit a pull request. Please ensure your contributions follow the existing format and style of the documentation.
- Help with Migration: We’ll be moving this documentation to a DokuWiki-based website. If you have experience with DokuWiki or want to assist with the migration, we’d love your help.
- Phase 1: Maintain and update the documentation in this repository.
- Phase 2: Migrate documentation to the DokuWiki-based website.
- Phase 3: Maintain the website
For any questions, suggestions, or feedback, feel free to reach out via GitHub Issues or contact us directly at arda@artadosearch.com.
Thank you for contributing to Artado Search and helping to build a more open and private web!