mikluko/multiproxy
Watch
1
0
Fork
You've already forked multiproxy
 0
Code Issues Pull requests Projects Releases 2 Packages Activity Actions

docs: GLOSSARY.md and AGENTS.md #49

Merged
mikluko merged 1 commit from docs/glossary into main 2026-10-26 22:35:50 +00:00
Conversation 0 Commits 1 Files changed 3 +101
mikluko commented 2026-10-26 22:34:30 +00:00
Owner
Copy link

GLOSSARY.md names the domain: entry points, targets, upstreams, host patterns, fallback and refusal; tunnel, MITM, intercepted requests, accept, proxy CA, leaf certificate and upstream verification; proxy headers, header rules, access and server records. Each term picks one word and lists the competing ones under Avoid.

AGENTS.md points agents at the README, which indexes the docs, and at the glossary. The README lists the glossary under Reference.

The code still uses three of the avoided words: "MITM certificates" in four flag-help and doc comments in cmd/multiproxy/main.go, "issued certificates" in the issuer docs and the command-line reference, and "sub-requests" in MITMHandler.Handler's doc. They are left for a follow-up.

`GLOSSARY.md` names the domain: entry points, targets, upstreams, host patterns, fallback and refusal; tunnel, MITM, intercepted requests, accept, proxy CA, leaf certificate and upstream verification; proxy headers, header rules, access and server records. Each term picks one word and lists the competing ones under Avoid. `AGENTS.md` points agents at the README, which indexes the docs, and at the glossary. The README lists the glossary under Reference. The code still uses three of the avoided words: "MITM certificates" in four flag-help and doc comments in `cmd/multiproxy/main.go`, "issued certificates" in the `issuer` docs and the command-line reference, and "sub-requests" in `MITMHandler.Handler`'s doc. They are left for a follow-up.
docs: GLOSSARY.md, and AGENTS.md pointing agents at README and the glossary
All checks were successful
CI / changelog (pull_request) Successful in 6s
Details
CI / test (pull_request) Successful in 53s
Details
de3d54869d
mikluko deleted branch docs/glossary 2026-10-26 22:35:50 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug
Something isn't working

  
dependencies
Pull requests that update a dependency file

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
question
Further information is requested

  
wontfix
This will not be worked on

No labels
bug
dependencies
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
mikluko/multiproxy!49
No description provided.