Skip to content

Commit 628941e

Browse files
felps-devclaude
andcommitted
docs: Move source maps to docs/ and rename CLAUDE.md to AGENTS.md
Address PR #448 review feedback: consolidate documentation files under docs/ directory and use model-agnostic AGENTS.md naming. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 19840a9 commit 628941e

10 files changed

Lines changed: 13 additions & 12 deletions

CLAUDE.md renamed to AGENTS.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# CLAUDE.md - PyNFe
1+
# AGENTS.md - PyNFe
22

33
Brazilian electronic fiscal document library (NF-e, NFC-e, NFS-e, MDF-e, CT-e) for SEFAZ webservice communication.
44

55
## Source Map Navigation (MANDATORY)
66

7-
**Before reading any large file (>200 lines), you MUST first read its `{filename}_map.md` file** in the same directory. The source map contains:
7+
**Before reading any large file (>200 lines), you MUST first read its `{filename}_map.md` file** in the `docs/` directory. The source map contains:
88
- Section-by-section breakdown with exact line ranges
99
- Class/method index with purpose descriptions
1010
- Field group documentation
@@ -15,26 +15,27 @@ This allows you to navigate directly to the specific line-window you need instea
1515

1616
| Source Map | File | Lines | Description |
1717
|------------|------|-------|-------------|
18-
| `pynfe/processamento/serializacao_map.md` | `serializacao.py` | 2630 | XML serialization (NF-e, MDF-e, QR codes) |
19-
| `pynfe/processamento/comunicacao_map.md` | `comunicacao.py` | 1348 | SEFAZ webservice communication |
20-
| `pynfe/processamento/autorizador_nfse_map.md` | `autorizador_nfse.py` | 538 | NFS-e authorization (Betha/Ginfes) |
21-
| `pynfe/entidades/notafiscal_map.md` | `notafiscal.py` | 1253 | Invoice entities and tax fields |
22-
| `pynfe/entidades/manifesto_map.md` | `manifesto.py` | 447 | MDF-e manifest entities |
23-
| `pynfe/entidades/evento_map.md` | `evento.py` | 237 | Event entities (cancel, correction, etc.) |
24-
| `pynfe/utils/flags_map.md` | `flags.py` | 645 | Constants, namespaces, tax codes |
25-
| `pynfe/utils/webservices_map.md` | `webservices.py` | 572 | SEFAZ endpoint URLs by state |
26-
| `pynfe/utils/utils_map.md` | `__init__.py` | 253 | Utility functions (municipality lookup, signing) |
18+
| `docs/serializacao_map.md` | `pynfe/processamento/serializacao.py` | 2630 | XML serialization (NF-e, MDF-e, QR codes) |
19+
| `docs/comunicacao_map.md` | `pynfe/processamento/comunicacao.py` | 1348 | SEFAZ webservice communication |
20+
| `docs/autorizador_nfse_map.md` | `pynfe/processamento/autorizador_nfse.py` | 538 | NFS-e authorization (Betha/Ginfes) |
21+
| `docs/notafiscal_map.md` | `pynfe/entidades/notafiscal.py` | 1253 | Invoice entities and tax fields |
22+
| `docs/manifesto_map.md` | `pynfe/entidades/manifesto.py` | 447 | MDF-e manifest entities |
23+
| `docs/evento_map.md` | `pynfe/entidades/evento.py` | 237 | Event entities (cancel, correction, etc.) |
24+
| `docs/flags_map.md` | `pynfe/utils/flags.py` | 645 | Constants, namespaces, tax codes |
25+
| `docs/webservices_map.md` | `pynfe/utils/webservices.py` | 572 | SEFAZ endpoint URLs by state |
26+
| `docs/utils_map.md` | `pynfe/utils/__init__.py` | 253 | Utility functions (municipality lookup, signing) |
2727

2828
### How to Use Source Maps
2929

3030
1. **Read the `_map.md` file first** to understand the file structure
3131
2. **Identify the line range** you need from the map tables
3232
3. **Read only that section** using `offset` and `limit` parameters
33-
4. Example: To understand ICMS CST 60 serialization, read `serializacao_map.md`, find it's at lines 747-770, then read `serializacao.py` with `offset=747, limit=25`
33+
4. Example: To understand ICMS CST 60 serialization, read `docs/serializacao_map.md`, find it's at lines 747-770, then read `pynfe/processamento/serializacao.py` with `offset=747, limit=25`
3434

3535
## Project Structure
3636

3737
```
38+
docs/ # Documentation and source maps (*_map.md, reforma_tributaria.md)
3839
pynfe/
3940
├── entidades/ # Domain entities (data models)
4041
│ ├── base.py # Base entity class with kwargs init
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)