summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'relay-conflux-note3' into 'main'David Goulet2025-12-181-0/+606
|\ | | | | | | | | | | | | doc/dev/notes: Add note on relay conflux Closes #2273 See merge request tpo/core/arti!3533
| * doc/dev/notes: Say we might want buffering on the inner MPSCsGabriela Moldovan2025-12-111-4/+7
| |
| * doc/dev/notes: Say that ConfluxController may be folded into StreamReactorGabriela Moldovan2025-12-111-1/+4
| |
| * doc/dev/notes: Add more details on the client sideGabriela Moldovan2025-12-111-7/+198
| |
| * doc/dev/notes: Say that the split StreamMap design is TBDGabriela Moldovan2025-12-111-4/+4
| |
| * doc/dev/notes: Clarify the parts that apply to both stream handling designsGabriela Moldovan2025-12-111-5/+6
| |
| * doc/dev/notes: Move clarification closer to the diagramGabriela Moldovan2025-12-111-6/+5
| | | | | | | | | | | | I am about to add some text that applies to both designs, so I want to move this closer to the diagram to avoid a confusing interleaving of text.
| * doc/dev/notes: Say that we will have a single stream taskGabriela Moldovan2025-12-111-20/+46
| | | | | | | | | | For the initial implementation, we don't plan to split the read and write sides of the stream handling task.
| * doc/dev/notes: Rename Stream{BWD,FWD} to Stream{Read,Write}Gabriela Moldovan2025-12-101-22/+22
| | | | | | | | | | As suggested in https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/3533#note_3305914
| * doc/dev/notes: Add note on relay confluxGabriela Moldovan2025-12-081-0/+383
| | | | | | | | Closes #2273
* | rpc-connect-spec: Describe new behavior.Nick Mathewson2025-12-171-0/+3
| |
* | Merge branch 'semver-experimental' into 'main'Nick Mathewson2025-12-111-0/+6
|\ \ | |/ |/| | | | | doc: Mention `experimental` feature in Semver.md See merge request tpo/core/arti!3545
| * Fix some wordingClara Engler2025-12-111-2/+2
| |
| * doc: Mention `experimental` feature in Semver.mdClara Engler2025-12-101-0/+6
| | | | | | | | | | | | | | | | | | The `experimental` feature flags are not explicitly mentioned anywhere in the `doc/Semver.md` file. This commit changes that by adding a paragraph documenting the status quo, namely that functionalities gated behind an opt-in experimental flag may break despite an unchanged major version number.
* | Fix the JSON in rpc-book/messages-and-json.md.Pier Angelo Vendrame2025-12-041-2/+2
|/ | | | | Added a missing quote and removed a trailing comma to make a JSON snippet from the RPC documentation valid.
* doc/hsc.md: Add clarification about KeystoreIdsIan Jackson2025-11-241-1/+2
| | | | | Applies @Dizet's suggestion from https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/3485#note_3291709
* doc/hsc.md: Use toml block for config exampleGabriela Moldovan2025-11-241-1/+1
|
* doc/hsc.md: Remove note about invalid keystoresGabriela Moldovan2025-11-241-7/+0
| | | | | | | | | | | I don't think we need to tell users a C Tor keystore cannot have more than one client entry for the same onion service, because they already know that: C Tor doesn't allow it, so if they are migrating an existing C Tor configuration, it will likely be valid. And if not, the error message will inform them what went wrong. So I am removing this section in the interest in keeping this guide short and sweet and straight to the point.
* doc/hsc.md: Warn against running tor/arti during the migrationGabriela Moldovan2025-11-241-0/+6
| | | | This is analogous to the warning from `doc/hss.md`.
* doc/hsc.md: s/ctor-keystore-id/ctor-clientGabriela Moldovan2025-11-241-3/+3
| | | | | Otherwise users might think it's idiomatic/necessary to add the `-id` suffix to their keystore identifiers.
* doc/hsc.md: Rephrase section about --batchGabriela Moldovan2025-11-241-5/+5
| | | | | This makes the language more consistent with the `hss ctor-migrate` docs.
* doc/hsc.md: Add missing text before example invocationGabriela Moldovan2025-11-241-0/+2
|
* doc/hsc.md: Say keystore identifiers must be uniqueGabriela Moldovan2025-11-241-0/+3
|
* doc/hsc.md: Add comments to the config exampleGabriela Moldovan2025-11-241-0/+12
| | | | | This should help clarify what each of those options means. It's also consistent with the analogous example from `doc/hss.md`.
* doc/hsc.md: Remove config from usage exampleGabriela Moldovan2025-11-241-1/+1
| | | | There's no need to pass a config file when using `-o`.
* doc/hsc.md: Rewrite usage section for better readabilityGabriela Moldovan2025-11-241-5/+3
|
* doc/hsc.md: Move warning higher up in the documentGabriela Moldovan2025-11-241-12/+12
|
* doc/hsc.md: Add a more user-friendly introGabriela Moldovan2025-11-241-2/+5
| | | | | | This a bit more user-friendly, because not all users will know what "a registered C Tor keystore is". It's also more consistent with the style from the `hss ctor-migrate` docs (for migrating service keys).
* doc/hsc.md: Use gerund in headingsGabriela Moldovan2025-11-241-1/+1
| | | | For consistency with the other headings.
* Add `hsc key ctor-migrate` subcommandhjrgrn2025-11-241-3/+57
|
* Update P101 numbers for September 2025.Alexander Hansen Færøy2025-10-291-0/+30
|
* doc: add note about increasing minor version for MSRV changesSteven Engler2025-10-281-0/+4
|
* docs: Add note about cargo-sort version to release checklist.Wesley Aptekar-Cassels2025-10-211-5/+6
|
* docs: Move updating steps to end of release checklist.Wesley Aptekar-Cassels2025-10-211-51/+49
| | | | | | As discussed at the meeting today, upgrading things at the end of the release instead of the beginning ensures that we have a month of testing everything before we ship updates out to users.
* Merge branch 'ci-specify-shellcheck-editorconfig-versions' into 'main'wesleyac2025-10-211-3/+15
|\ | | | | | | | | | | | | CI: Specify versions for shellcheck and editorconfig-checker. Closes #2219 See merge request tpo/core/arti!3366
| * CI: Specify versions for shellcheck and editorconfig-checker.Wesley Aptekar-Cassels2025-10-161-3/+15
| | | | | | | | Fixes: #2219
* | doc: add note about relays enforcing proto recommendationsSteven Engler2025-10-201-0/+9
|/
* doc/hss.md: Use implementation-agnostic markdown.Gabriela Moldovan2025-10-141-10/+8
| | | | This will make the doc render nicely outside of GitLab too.
* doc/hss.md: Insert missing wordGabriela Moldovan2025-10-141-1/+1
|
* doc/hss.md: Say that the svc must be shut down for migration.gabi-2502025-10-141-0/+1
|
* doc/hss.md: Add basic usage instructions for arti hssGabriela Moldovan2025-10-141-0/+101
| | | | Closes #2108
* doc: Add relay task dev notesDavid Goulet2025-10-141-0/+208
| | | | | | Closes #2216 Signed-off-by: David Goulet <[email protected]>
* doc: Remove extra new line in `keys.md`hjrgrn2025-10-081-1/+0
|
* doc: Update `check-integrity` section in `keys.md`hjrgrn2025-10-081-187/+91
|
* docs: Move list ordering in Release.md.Wesley Aptekar-Cassels2025-10-071-2/+2
|
* docs: Mention examples and maint crates in release docs.Wesley Aptekar-Cassels2025-10-071-0/+2
| | | | | This seems to describe our current de-facto policy, and it seems reasonable not to bump versions for crates we aren't publishing.
* Merge branch 'cargo-add' into 'main'wesleyac2025-10-071-0/+3
|\ | | | | | | | | Release.md: Suggest using cargo owner --add to update the owners. See merge request tpo/core/arti!3334
| * Release.md: Suggest using cargo owner --add to update the owners.Gabriela Moldovan2025-10-061-0/+3
| | | | | | | | This is less fiddly than using the crates.io UI.
* | Merge branch 'describe-channel-padding' into 'main'Nick Mathewson2025-10-061-0/+65
|\ \ | |/ |/| | | | | circuit-padding.md: Describe how per-channel padding will work. See merge request tpo/core/arti!3302
| * circuit-padding: correct how channel padding detects queued cellsNick Mathewson2025-10-021-1/+6
| |