Related updates to the FAQ to point to new documentation

[reactive-firewall]

Followup chore

• see also GHI Update Documentation for CI/CD with recent overhaul #410
• see also GHI Update Documentation for Project Testing #411

Chore

• add related questions to the FAQ to point readers to the new documentation

[reactive-firewall]

Sample Q&A to add to FAQ:

How do I configure my environment for multicast development?

To configure your environment for developing with the multicast library, follow the steps in the Install Guide.
Key steps include:

1. Ensuring you have a supported version of Python installed.
2. use pip to install
3. in python: import multicast; in bash: python3 -m multicast --help

Implementation draft

### How do I configure my environment for multicast development?

To configure your environment for developing with the multicast library, follow the steps in the [Install Guide](https://github.com/reactive-firewall/multicast/tree/HEAD/docs/INSTALL.md).
Key steps include:

  1. Ensuring you have a supported version of Python installed.
  2. use pip to install
  3. in python: `import multicast`; in bash: `python3 -m multicast --help`

---

What should I do if I encounter a specific exception while using the multicast library?

If you encounter an exception, consult the troubleshooting guide. This guide lists common exceptions, their causes, and recommended solutions.
For example:

• Network errors: Check your network settings and firewall rules.
• Value errors: Ensure you are providing valid arguments to multicast API calls.

Implementation draft

### How do I configure my environment for multicast development?

### What should I do if I encounter a specific exception while using the multicast library?

If you encounter an exception, consult the troubleshooting guide. This guide lists common exceptions, their causes, and recommended solutions.
For example:

* socket errors: Consult _python socket docs_. Check your network settings and firewall rules.
* Value errors: Ensure you are providing valid arguments to [multicast API](api/multicast/) calls.

---

• TODO: fix the links

How do I run and interpret the test suite for this project?

To run the test suite, follow the instructions in the Testing Guide.

The guide explains test organization, and how to run tests outside CI/CD.

Implementation draft

### How do I run and interpret the test suite for this project?

To run the test suite, follow the instructions in the [Testing Guide](https://github.com/reactive-firewall/multicast/tree/HEAD/docs/Testing.md).

The guide explains test organization, and how to run tests outside CI/CD.

---

How is continuous integration (CI) set up for this repository?

CI is configured as described in the CI Guide.
Key points:

Automated builds and tests are run via GitHub Actions.
Each pull request is tested for compatibility and code quality.
The guide details the CI workflow files, environment variables, and what to expect when contributing changes.

Implementation draft

### How is continuous integration (CI) set up for this repository?

CI is configured as described in the [CI Guide](https://github.com/reactive-firewall/multicast/tree/HEAD/docs/CI.md).
Key points:

Automated builds and tests are run via GitHub Actions.
Each pull request is tested for compatibility and code quality.
The guide details the CI workflow files, environment variables, and what to expect when contributing changes.

---

[reactive-firewall]

what about security?

# Security

If you find a significant vulnerability, or evidence of one,
please report it privately.

We prefer that you use the [GitHub mechanism for privately reporting a vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability). Under the
[main repository's security tab](https://github.com/reactive-firewall/multicast/security), click "Report a vulnerability" to open the advisory form.