Commit abb5bb9c authored by Jan Reimes's avatar Jan Reimes
Browse files

docs: update documentation for consistency and clarity 

- Standardize list numbering across multiple documents.
- Improve formatting with separators for better readability.
parent aadb38a4

docs/agents-md/800_Documentation.md

+1 −1
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ 
This repository maintains separate documentation for humans and for coding agents:



1. **docs/index.md** - Main documentation entry point (Jekyll-ready)

1. **docs/*.md** - Modular task-oriented user guides (crawl, query, utils, etc.)

1. **docs/\*.md** - Modular task-oriented user guides (crawl, query, utils, etc.)

1. **README.md** - Project overview and contributor entry points

1. **docs/agents-md/** - Agent-facing modular implementation and workflow guidance

1. **AGENTS.md** - Core guidelines and rules for coding agents (standalone context)

docs/crawl.md

+2 −2
Original line number Diff line number Diff line
@@ -41,7 +41,7 @@ tdoc-crawler crawl-meetings -w SA 
tdoc-crawler crawl-meetings --limit-meetings-per-wg 10

```



---

______________________________________________________________________



### `crawl-tdocs` (alias: `ct`)
@@ -76,7 +76,7 @@ tdoc-crawler crawl-tdocs -w RAN -s R1 -s R2 
tdoc-crawler crawl-tdocs -w RAN --workers 8

```



---

______________________________________________________________________



### `crawl-specs` (alias: `cs`)

docs/development.md

+2 −2
Original line number Diff line number Diff line
@@ -13,13 +13,13 @@ This guide describes how to set up your environment for contributing to `tdoc-cr 
   cd tdoc-crawler

   ```



2. Sync dependencies:

1. Sync dependencies:



   ```bash

   uv sync --all-extras

   ```



3. Install pre-commit hooks:

1. Install pre-commit hooks:



   ```bash

   uv run pre-commit install

docs/misc.md

+2 −2
Original line number Diff line number Diff line
@@ -41,8 +41,8 @@ While `tdoc-crawler` primarily uses **WhatTheSpec** for its speed and lack of re 
The tool prefers unauthenticated community access first, falling back to 3GPP portal if credentials are provided:



1. CLI parameters (`--eol-username`, `--eol-password`).

2. Environment variables (`TDC_EOL_USERNAME`, `TDC_EOL_PASSWORD`).

3. Interactive prompt (if `TDC_EOL_PROMPT=true`).

1. Environment variables (`TDC_EOL_USERNAME`, `TDC_EOL_PASSWORD`).

1. Interactive prompt (if `TDC_EOL_PROMPT=true`).



## Directory Structure

docs/query.md

+2 −2
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ tdoc-crawler query-tdocs --working-group RAN --limit 20 
tdoc-crawler query-tdocs R1-2400001 --output json

```



---

______________________________________________________________________



### `query-meetings` (alias: `qm`)
@@ -62,7 +62,7 @@ tdoc-crawler query-meetings -w RP -s "RAN Plenary" 
tdoc-crawler query-meetings --output yaml

```



---

______________________________________________________________________



### `query-specs` (alias: `qs`)