minor formatting changes

This commit is contained in:
2026-02-27 21:16:05 +05:30
parent 7643e27358
commit caeda0ad5c
2 changed files with 25 additions and 25 deletions

View File

@@ -7,7 +7,7 @@ modules and objects, and renders that model into documentation outputs without
executing your code.
---
## Core Philosophy
# Core Philosophy
`doc-forge` follows a compiler architecture:
@@ -23,7 +23,7 @@ executing your code.
* MCP JSON → AI-readable documentation
---
## Docstring Writing Standard
# Docstring Writing Standard
Docstrings are the single source of truth. `doc-forge` does not generate content.
It compiles and renders what you write.
@@ -31,23 +31,23 @@ It compiles and renders what you write.
Documentation follows the Python import hierarchy.
---
## Package docstring (`package/__init__.py`) — Full user guide
# Package docstring (`package/__init__.py`) — Full user guide
This is the landing page. A developer must be able to install and use the
package after reading only this docstring.
Example:
## Example:
'''
Short description of what this package provides.
## Installation
# Installation
```bash
pip install my-package
```
## Quick start
# Quick start
```python
from my_package.foo import Bar
@@ -57,23 +57,23 @@ Example:
```
---
## Core concepts
# Core concepts
### Bar
## Bar
- Primary object exposed by the package.
### foo module
## foo module
- Provides core functionality.
---
## Typical workflow
# Typical workflow
1. Import public objects
2. Initialize objects
3. Call methods
---
## Public API
# Public API
foo.Bar
foo.helper_function
@@ -81,16 +81,16 @@ Example:
'''
---
## Submodule docstring (`package/foo/__init__.py`) — Subsystem guide
# Submodule docstring (`package/foo/__init__.py`) — Subsystem guide
Explains a specific subsystem.
Example:
## Example:
'''
Provides core functionality.
## Usage
# Usage
```python
from my_package.foo import Bar
@@ -102,11 +102,11 @@ Example:
'''
---
## Class docstring — Object contract
# Class docstring — Object contract
Defines responsibility and behavior.
Example:
## Example:
```python
class Bar:
@@ -126,9 +126,9 @@ Include:
* Performance characteristics (if relevant)
---
## Function and method docstrings — API specification
# Function and method docstrings — API specification
Example:
## Example:
```python
def process(
@@ -178,9 +178,9 @@ def process(
```
---
## Attribute docstrings (optional)
# Attribute docstrings (optional)
Example:
## Example:
```python
class Class
@@ -206,7 +206,7 @@ class Class
```
---
## Writing Rules
# Writing Rules
**Required**
@@ -224,15 +224,15 @@ class Class
* Informal or conversational language
---
## How doc-forge uses these docstrings
# How doc-forge uses these docstrings
### Build MkDocs site:
## Build MkDocs site:
```bash
doc-forge build --mkdocs --module my_package
```
### Build MCP documentation:
## Build MCP documentation:
```bash
doc-forge build --mcp --module my_package