[DRAFT] Documentation website

[Frezyx]

Summary by Sourcery

Add a VitePress-based documentation website for the Talker ecosystem with English and Russian content, including package docs, guides, integrations, and examples.

New Features:

• Introduce a dedicated documentation site powered by VitePress for browsing Talker ecosystem information.
• Provide bilingual documentation (English and Russian) for core Talker packages, integrations, and usage guides.
• Add interactive DartPad and web demo entry points to explore Talker features directly from the docs.

Enhancements:

• Document configuration, customization options, and advanced usages for Talker, Talker Flutter, and Talker Logger.
• Describe and organize HTTP, gRPC, BLoC, Riverpod, and Chopper logging integrations in a unified docs structure.
• Add high-level getting started, quick start, and examples sections to improve onboarding for new users.

Build:

• Add a website package with VitePress configuration and npm scripts to develop, build, and preview the documentation site.

Documentation:

• Create comprehensive package reference pages for talker, talker_flutter, and talker_logger in English and Russian.
• Add guides covering custom log types, custom error messages, Crashlytics/Sentry integration, and route logging in both languages.
• Define a localized VitePress navigation and sidebar structure for English and Russian documentation, including examples and ecosystem overviews.

[sourcery-ai]

Reviewer's Guide

Adds a new VitePress-based documentation website for the Talker ecosystem, including English and Russian home pages, getting-started guides, package references, integrations, advanced guides, examples, and configuration/theme files for the docs site.

Flow diagram for documentation sections and page relationships

flowchart TD
  Home_en["Home /index.md"]
  Home_ru["Home /ru/index.md"]

  subgraph GettingStarted_en["Getting started (en)"]
    EN_installation["/getting-started/installation"]
    EN_quick_start["/getting-started/quick-start"]
    EN_why_talker["/getting-started/why-talker"]
  end

  subgraph GettingStarted_ru["Getting started (ru)"]
    RU_installation["/ru/getting-started/installation"]
    RU_quick_start["/ru/getting-started/quick-start"]
    RU_why_talker["/ru/getting-started/why-talker"]
  end

  subgraph Packages_en["Packages (en)"]
    EN_talker["/packages/talker"]
    EN_talker_flutter["/packages/talker-flutter"]
    EN_talker_logger["/packages/talker-logger"]
  end

  subgraph Packages_ru["Packages (ru)"]
    RU_talker["/ru/packages/talker"]
    RU_talker_flutter["/ru/packages/talker-flutter"]
    RU_talker_logger["/ru/packages/talker-logger"]
  end

  subgraph Integrations_en["Integrations (en)"]
    EN_dio["/integrations/dio"]
    EN_http["/integrations/http"]
    EN_bloc["/integrations/bloc"]
    EN_riverpod["/integrations/riverpod"]
    EN_chopper["/integrations/chopper"]
    EN_grpc["/integrations/grpc"]
  end

  subgraph Integrations_ru["Integrations (ru)"]
    RU_dio["/ru/integrations/dio"]
    RU_http["/ru/integrations/http"]
    RU_bloc["/ru/integrations/bloc"]
    RU_riverpod["/ru/integrations/riverpod"]
    RU_chopper["/ru/integrations/chopper"]
    RU_grpc["/ru/integrations/grpc"]
  end

  subgraph Guides_en["Guides (en)"]
    EN_custom_logs["/guides/custom-logs"]
    EN_crashlytics["/guides/crashlytics"]
    EN_routing["/guides/routing"]
    EN_custom_errors["/guides/custom-error-messages"]
  end

  subgraph Guides_ru["Guides (ru)"]
    RU_custom_logs["/ru/guides/custom-logs"]
    RU_crashlytics["/ru/guides/crashlytics"]
    RU_routing["/ru/guides/routing"]
    RU_custom_errors["/ru/guides/custom-error-messages"]
  end

  EN_examples["/examples.md"]
  RU_examples["/ru/examples.md"]

  Home_en --> GettingStarted_en
  Home_en --> Packages_en
  Home_en --> Integrations_en
  Home_en --> Guides_en
  Home_en --> EN_examples

  Home_ru --> GettingStarted_ru
  Home_ru --> Packages_ru
  Home_ru --> Integrations_ru
  Home_ru --> Guides_ru
  Home_ru --> RU_examples

  EN_talker --> EN_custom_logs
  EN_talker_flutter --> EN_custom_errors
  EN_talker_flutter --> EN_routing
  EN_talker --> EN_crashlytics

  RU_talker --> RU_custom_logs
  RU_talker_flutter --> RU_custom_errors
  RU_talker_flutter --> RU_routing
  RU_talker --> RU_crashlytics

Loading

File-Level Changes

Change	Details	Files
Introduce VitePress configuration, theming, and build scripts for the new documentation site.	Configure VitePress with multi-locale (English and Russian) support, navigation, sidebars, search, edit links, and footer metadata. Add a custom theme entry point and CSS to apply a purple Talker brand theme, tweak hero/feature styles, and style shared components like DartPad embeds. Add a package.json with VitePress as a dev dependency and npm scripts for developing, building, and previewing the docs site. Add a .gitignore for the website directory and commit a lockfile for deterministic installs.	website/docs/.vitepress/config.ts website/docs/.vitepress/theme/index.ts website/docs/.vitepress/theme/custom.css website/package.json website/package-lock.json website/.gitignore
Create English documentation pages for core Talker packages, guides, integrations, examples, and the landing page.	Add a home page with hero content, feature grid, DartPad embed, and ecosystem overview of all Talker-related packages. Document the core talker, talker_flutter, and talker_logger packages, including installation, basic usage, configuration options, and API references. Add getting-started docs (installation, quick start, and "Why Talker?" rationale) plus an examples page with DartPad snippets and links to the shop app and web demo. Add advanced guides for custom log types, Crashlytics/Sentry integration, custom error messages/UI, and route logging using TalkerRouteObserver. Add integration docs for Dio, http_interceptor, BLoC, Riverpod, Chopper, and gRPC loggers with setup, customization, and settings reference tables.	website/docs/index.md website/docs/getting-started/installation.md website/docs/getting-started/quick-start.md website/docs/getting-started/why-talker.md website/docs/packages/talker.md website/docs/packages/talker-flutter.md website/docs/packages/talker-logger.md website/docs/guides/custom-logs.md website/docs/guides/crashlytics.md website/docs/guides/custom-error-messages.md website/docs/guides/routing.md website/docs/integrations/dio.md website/docs/integrations/http.md website/docs/integrations/bloc.md website/docs/integrations/riverpod.md website/docs/integrations/chopper.md website/docs/integrations/grpc.md website/docs/examples.md
Provide full Russian translations/mirrors of the documentation site, including localized navigation, content, and links.	Add a Russian home page mirroring the English hero, feature list, DartPad section, and packages overview with localized text and routes. Create Russian versions of getting-started docs (installation, quick start, why Talker), examples, and package pages for talker, talker_flutter, and talker_logger. Add Russian translations of advanced guides (custom logs, Crashlytics/Sentry integration, custom error messages, route logging). Add Russian integration docs for Dio, http, BLoC, Riverpod, Chopper, and gRPC loggers with localized descriptions and settings tables. Wire Russian docs into the VitePress locale config, including localized nav labels, sidebar structure, and UI strings (outline, footer, menus).	website/docs/ru/index.md website/docs/ru/getting-started/installation.md website/docs/ru/getting-started/quick-start.md website/docs/ru/getting-started/why-talker.md website/docs/ru/packages/talker.md website/docs/ru/packages/talker-flutter.md website/docs/ru/packages/talker-logger.md website/docs/ru/guides/custom-logs.md website/docs/ru/guides/crashlytics.md website/docs/ru/guides/custom-error-messages.md website/docs/ru/guides/routing.md website/docs/ru/integrations/dio.md website/docs/ru/integrations/http.md website/docs/ru/integrations/bloc.md website/docs/ru/integrations/riverpod.md website/docs/ru/integrations/chopper.md website/docs/ru/integrations/grpc.md website/docs/ru/examples.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.