<aside>
🗓️
December 17, 2024
</aside>
<aside>
https://miro.com/app/board/uXjVL2Fi8vs=/
</aside>
<aside>
https://boost.filecoin.io/getting-started
</aside>
Brief
5 members of the UX Improvement Team at the Filecoin Foundation, each with varying levels of technical expertise, were assigned to review the latest version of the Boost Documentation. The initial goal was for them to use Boost to store data on Filecoin. However, shortly after starting, they encountered issues with installing Boost. As a result, this session ended up focusing solely on the installation tutorial. Their task was to identify and document any difficulties in understanding the presented information, as well as to note inconsistencies or unclear descriptions.
Key Issues and Recommendations
Docker Container Request
- Observation: One participant suggested packaging the installation as a Docker container.
- Suggestion: Consider including a section on setting up Boost via Docker for users who prefer containerized environments. Provide a prebuilt Docker image or Dockerfile with necessary configurations.
Node.js Version
- Observation: The tutorial specifies installing Node.js version 16.
- Suggestion: Update the instructions to recommend installing Node.js version 20, as this is the latest LTS version. This ensures compatibility with recent packages and security updates.
- https://github.com/filecoin-project/boost-docs/pull/66
Prerequisites
- Observation: Participants questioned why Node.js was included under prerequisites, but Go and Rust were not.
- Suggestion: List all prerequisites explicitly (Node.js, Go, Rust, jq, etc.) with a brief explanation of their roles in the installation process. Ensure the compatibility versions are clearly stated.