User Feedback

[milank94]

In reference to https://docs.tenstorrent.com/syseng/latest/softwaresetup.html

• Under Install TT-Flash, need to indicate which Python version
• Include Rust install advice
• CURL installation instructions
• Git installation instructions
• Include wget installation instructions - specify clearly the version and the range of versions that works (It’s about professionalism)
• Refer to the error to ensure that there’s no error. Although everything was successful in the end. There should not be any error messages appearing. (Refer to error image)
• Include proper copy buttons
• After installation, TT-flash is located in different directory. It Should be made in the same directory and added into the path
• KOL had to configure his own path to improve user experience for future uses
• Solution: Create a whole pre-installed toolkit

[warthog9]

Running inline since there's a lot here

In reference to https://docs.tenstorrent.com/syseng/latest/softwaresetup.html

• Under Install TT-Flash, need to indicate which Python version

Slightly confused on this one, is the question is the quite EOL python2 that seems to still be in Ubuntu 20.04 an option vs. python3?

• Include Rust install advice

We'll add that, already present on the repos themselves so not an issue.

• CURL installation instructions

CURL based install instructions are a fundamental security issue, and should not be encouraged by any stretch of the imagination. We've already got work on getting proper distro packaging sorted out for syseng tools which should accomplish the same basic level of simplicity

• Git installation instructions

Git itself, or how to install from git repos? Confused on this as the repos have separate, developer centric, install instructions already, and I wouldn't assume normal end users to be installing that way.

• Include wget installation instructions - specify clearly the version and the range of versions that works (It’s about professionalism)

This is going to need more elaboration as I'm not sure what's being asked for here? If it's a similar situation to CURL and pipping to a shell, that's fundamentally no different than the CURL situation above. If it's downloading other pieces - we don't currently support anything like that per-se and right now that would make the instructions a lot more complicated to get there.

That being said we may switch to something similar when we've got proper distro packaging, but that's still in progress.

• Refer to the error to ensure that there’s no error. Although everything was successful in the end. There should not be any error messages appearing. (Refer to error image)

Image is missing, we have no context for what's going on here. This should probably be filed against the tool in question itself vs. here as it's not documentation related per-se.

• Include proper copy buttons

In theory we are already using the correct blocks for Github markdown to add that automatically, so I assume something about the added interpretation and compilation steps are preventing that. @dsklavos ?

• After installation, TT-flash is located in different directory. It Should be made in the same directory and added into the path

Confused how these would be installed in a different location? If they follow the instructions they would be installed to either the users' or system's default python path / locations and should (for most systems) be in the normal execution path. You can execute them from inside the directories but that's not expected

• KOL had to configure his own path to improve user experience for future uses

Can you elaborate on this?

• Solution: Create a whole pre-installed toolkit

[dsklavos]

It looks like the copy buttons aren't showing up after the .md is ingested. I'll check with Dimitri on this to see if it's something we can fix or if it's a limitation of Sphinx.