docs: Questions for Arti documentation
Hi Arti team, these are the questions I have(for now) to help move things forward. I appreciate your responses.
@nickm @ahf @Diziet @gabi-250 @gaba
cc @pkafei @charlie-doc-writer @harleta
- On the Arti Public Development meetings page, what would you prefer to have on there? Should it link to this meeting pad, or can we approach it like the the
changelog
with all its content on a page? If we approach it as the changelog, it would have to be updated when the meeting pad is updated. Please let us know which is convenient for the team. - What are the things Arti currently do that users need to know? This is for the What Arti can't do yet page.
- I need more details on censorship circumvention for Arti. I haven't found anything on this yet.
- To connect to an onion service with Arti, there are two approaches. For the one where they have to edit a config file, what config file is that?
- What development tools are used in building Arti, and in what context are they used?
- I need a clearer explanation on the architecture of Arti and how it differs from C Tor. There's not so much on the
architecture.md
file.
The for-developers section is meant for engineers who would like to contribute to Arti. For this section, I have the following questions:
- How does one add new Arti crates?
- How does one create new configuration options for Arti?
- Is exposing a new api the same as adding new crates? If no, how does one expose a new api?
- Can the
safelogging.md
file be used for the error handling and logging section? - Is
errors.md
a detailed guide for error handling when developing Arti? - Can the docs under the testing directory be used for the testing and mocking section of the documentation?
- Are the Configurations and ClI commands for Arti documented anywhere? This is for the reference manual which should contain commands and what they're used for.
Edited by oluchinwenyi