Improve test coverage

.cursor/rules/notes-llms-txt.mdc

@@ -0,0 +1,42 @@
+---
+description: LLM-friendly markdown format for notes directories
+globs: notes/**/*.md,**/notes/**/*.md
+alwaysApply: true
+---
+
+# Instructions for Generating LLM-Optimized Markdown Content
+
+When creating or editing markdown files within the specified directories, adhere to the following guidelines to ensure the content is optimized for LLM understanding and efficient token usage:
+
+1. **Conciseness and Clarity**:
+   - **Be Brief**: Present information succinctly, avoiding unnecessary elaboration.
+   - **Use Clear Language**: Employ straightforward language to convey ideas effectively.
+
+2. **Structured Formatting**:
+   - **Headings**: Utilize markdown headings (`#`, `##`, `###`, etc.) to organize content hierarchically.
+   - **Lists**: Use bullet points (`-`) or numbered lists (`1.`, `2.`, etc.) to enumerate items clearly.
+   - **Code Blocks**: Enclose code snippets within triple backticks (```) to distinguish them from regular text.
+
+3. **Semantic Elements**:
+   - **Emphasis**: Use asterisks (`*`) or underscores (`_`) for italicizing text to denote emphasis.
+   - **Strong Emphasis**: Use double asterisks (`**`) or double underscores (`__`) for bold text to highlight critical points.
+   - **Inline Code**: Use single backticks (`) for inline code references.
+
+4. **Linking and References**:
+   - **Hyperlinks**: Format links using `[Link Text](mdc:URL)` to provide direct access to external resources.
+   - **References**: When citing sources, use footnotes or inline citations to maintain readability.
+
+5. **Avoid Redundancy**:
+   - **Eliminate Repetition**: Ensure that information is not unnecessarily repeated within the document.
+   - **Use Summaries**: Provide brief summaries where detailed explanations are not essential.
+
+6. **Standard Compliance**:
+   - **llms.txt Conformance**: Structure the document in alignment with the `llms.txt` standard, which includes:
+     - An H1 heading with the project or site name.
+     - A blockquote summarizing the project's purpose.
+     - Additional markdown sections providing detailed information.
+     - H2-delimited sections containing lists of URLs for further details.
+
+By following these guidelines, the markdown files will be tailored for optimal LLM processing, ensuring that the content is both accessible and efficiently tokenized for AI applications.
+
+For more information on the `llms.txt` standard, refer to the official documentation: https://llmstxt.org/

docs/api/cli/index.md

@@ -8,7 +8,6 @@
 :caption: General commands
 :maxdepth: 1
 
-sync
 ```
 
 ## vcspull CLI - `vcspull.cli`
@@ -19,3 +18,12 @@ sync
    :show-inheritance:
    :undoc-members:
 ```
+
+## Commands - `vcspull.cli.commands`
+
+```{eval-rst}
+.. automodule:: vcspull.cli.commands
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/config_models.md

@@ -0,0 +1,39 @@
+# Configuration Models - `vcspull.config.models`
+
+This page documents the Pydantic models used to configure VCSPull.
+
+## Repository Model
+
+The Repository model represents a single repository configuration.
+
+```{eval-rst}
+.. autopydantic_model:: vcspull.config.models.Repository
+   :inherited-members: BaseModel
+   :model-show-json: True
+   :model-show-field-summary: True
+   :field-signature-prefix: param
+```
+
+## Settings Model
+
+The Settings model controls global behavior of VCSPull.
+
+```{eval-rst}
+.. autopydantic_model:: vcspull.config.models.Settings
+   :inherited-members: BaseModel
+   :model-show-json: True
+   :model-show-field-summary: True
+   :field-signature-prefix: param
+```
+
+## VCSPullConfig Model
+
+The VCSPullConfig model is the root configuration model for VCSPull.
+
+```{eval-rst}
+.. autopydantic_model:: vcspull.config.models.VCSPullConfig
+   :inherited-members: BaseModel
+   :model-show-json: True
+   :model-show-field-summary: True
+   :field-signature-prefix: param
+``` 

docs/api/index.md

@@ -6,6 +6,13 @@
 For granular control see {ref}`libvcs <libvcs:index>`'s {ref}`Commands <libvcs:cmd>` and {ref}`Projects <libvcs:projects>`.
 :::
 
+## Configuration
+
+```{toctree}
+config
+config_models
+```
+
 ## Internals
 
 :::{warning}
@@ -15,12 +22,7 @@ If you need an internal API stabilized please [file an issue](https://github.com
 :::
 
 ```{toctree}
-config
 cli/index
-exc
-log
-internals/index
-validator
-util
 types
+logger
 ```

docs/api/logger.md

@@ -0,0 +1,8 @@
+# Logging - `vcspull._internal.logger`
+
+```{eval-rst}
+.. automodule:: vcspull._internal.logger
+   :members:
+   :show-inheritance:
+   :undoc-members:
+``` 

docs/conf.py

@@ -41,6 +41,7 @@
     "sphinxext.rediraffe",
     "myst_parser",
     "linkify_issues",
+    "sphinxcontrib.autodoc_pydantic",
 ]
 myst_enable_extensions = [
     "colon_fence",
@@ -122,6 +123,19 @@
 autodoc_typehints = "description"  # show type hints in doc body instead of signature
 simplify_optional_unions = True
 
+# autodoc_pydantic configuration
+autodoc_pydantic_model_show_json = True
+autodoc_pydantic_model_show_config = True
+autodoc_pydantic_model_show_validator_members = True
+autodoc_pydantic_model_show_field_summary = True
+autodoc_pydantic_model_member_order = "bysource"
+autodoc_pydantic_model_hide_paramlist = False
+autodoc_pydantic_model_undoc_members = True
+autodoc_pydantic_field_list_validators = True
+autodoc_pydantic_field_show_constraints = True
+autodoc_pydantic_settings_show_json = True
+autodoc_pydantic_settings_show_config = True
+
 # sphinx.ext.napoleon
 napoleon_google_docstring = True
 napoleon_include_init_with_doc = True

docs/configuration/index.md

@@ -93,6 +93,7 @@ YAML:
 :hidden:
 
 generation
+schema
 ```
 
 ## Caveats

docs/configuration/schema.md

@@ -0,0 +1,36 @@
+# Configuration Schema
+
+This page provides the detailed JSON Schema for the VCSPull configuration.
+
+## JSON Schema
+
+The following schema is automatically generated from the VCSPull configuration models.
+
+```{eval-rst}
+.. autopydantic_model:: vcspull.config.models.VCSPullConfig
+   :model-show-json-schema: True
+   :model-show-field-summary: True
+   :field-signature-prefix: param
+```
+
+## Repository Schema
+
+Individual repository configuration schema:
+
+```{eval-rst}
+.. autopydantic_model:: vcspull.config.models.Repository
+   :model-show-json-schema: True
+   :model-show-field-summary: True
+   :field-signature-prefix: param
+```
+
+## Settings Schema
+
+Global settings configuration schema:
+
+```{eval-rst}
+.. autopydantic_model:: vcspull.config.models.Settings
+   :model-show-json-schema: True
+   :model-show-field-summary: True
+   :field-signature-prefix: param
+```