Skip to content

Conversation

@andrewm4894
Copy link
Owner

This pull request adds comprehensive documentation for Anomstack, focusing on core concepts, configuration, and support for various data sources. The most significant changes include introducing a detailed overview of Anomstack's core concepts, providing guidance on metrics configuration, and adding dedicated pages for supported data sources.

Core Concepts and Configuration:

  • docs/docs/concepts.md: Introduced a detailed explanation of Anomstack's core concepts, including metric batches, job types (e.g., ingest, train, score), alerts, dashboards, storage, data sources, configuration, scheduling, and the LLM agent.
  • docs/docs/configuration/metrics.md: Added documentation on configuring metrics, including properties, YAML file structure, and placeholders for examples and best practices.

Data Source Documentation:

- Updated `sidebars.js` to organize documentation into categories: Getting Started, Core Features, Data Sources, Storage, Deployment, Configuration, and API Reference.
- Expanded `intro.md` to provide a comprehensive overview of Anomstack, including key features, how it works, supported data sources, storage options, and getting started guides.
- Simplified the structure of `sidebars.js` by removing redundant paths and consolidating items under relevant categories, including Data Sources, Storage, Deployment, and API Reference.
- Updated `sidebars.js` to include additional data sources: ClickHouse, DuckDB, SQLite, MotherDuck, Turso, and Redshift.
- Expanded `quickstart.md` with a section on ready-made example metrics, providing links to various metric batches for real data demonstration.
- Revised `python.md` to improve configuration details and added a comprehensive example for ingesting metrics from HackerNews.
- Updated `dashboard.md` to include a link to a live demo of the Anomstack dashboard showcasing its features.
@andrewm4894 andrewm4894 requested a review from Copilot June 2, 2025 22:20
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR significantly improves documentation for Anomstack by providing comprehensive guides on core concepts, metrics configuration, and support for various data sources. Key updates include new detailed pages for core concepts and configuration, dedicated documentation for multiple data sources, and an updated sidebar structure to help users navigate the docs.

Reviewed Changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/sidebars.js Updated sidebar configuration with new categories.
docs/docs/quickstart.md Added a quickstart guide with setup, installation, and usage instructions.
docs/docs/intro.md Revised introduction to include key features and architecture details.
docs/docs/features/*.md and others Added new documentation pages for metrics, anomaly detection, dashboard, alerts, LLM agent, and deployments.
docs/docs/data-sources/*.md Added comprehensive documentation for each supported data source.
docs/docs/configuration/metrics.md Introduced a new page outlining metrics configuration.
docs/docs/concepts.md Provided an in-depth explanation of Anomstack’s core concepts.
Comments suppressed due to low confidence (3)

docs/docs/quickstart.md:9

  • [nitpick] Consider advising users to create a virtual environment for dependency isolation prior to installing dependencies, which can help prevent potential issues in their setup.
## Prerequisites

docs/sidebars.js:81

  • Ensure that the renaming from 'GraphQL' to 'API Reference' aligns with the actual content in this category and update any related documentation references if necessary.
label: 'API Reference',

docs/docs/data-sources/python.md:18

  • Verify that the template inclusion syntax is correct and that the file path reflects the actual file structure; update it if necessary to avoid confusion for users.
{% include "./path/to/your/python/file.py" %}

- Replaced the links for Dagster Cloud and Local Development with a new link for GCP Deployment in `intro.md` to provide updated guidance for users.
@andrewm4894 andrewm4894 merged commit 3bc6802 into main Jun 2, 2025
3 checks passed
@andrewm4894 andrewm4894 deleted the improve-docs branch June 2, 2025 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants