Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move the guidelines to build example and load bitstream out from the Getting Started section #2668

Closed
umarcor opened this issue May 18, 2022 · 0 comments · Fixed by #2852
Closed
Labels
type-docs Issue is related to documentation.

Comments

@umarcor
Copy link
Contributor

umarcor commented May 18, 2022

Currently, readers of the Architecture Definitions documentation will find Getting Started with F4PGA Toolchain development as the first section to read. There, how to Build example and how to Load a bitstream are explained. The reason for such content to exist is probably historic (before f4pga-examples existed). However, in the context of chipsalliance/f4pga#555, it can be misleading for users (particularly those less familiar with the ecosystem).

We should move those subsections out from the Getting Started section. Getting Started should only explain how to install all the tools to run the fuzzers and to have the arch-defs assets (packages) generated. How to use those assets/packages should be not-so-easy to find in the docs of this repo:

  • If users are interested in those subsections only, they are probably potential users of f4pga-examples, not this repo.
  • Developers building the assets might want to test them, indeed. Hence, we can keep guidelines about how to run the smoke-tests available in this repo. However, we should place them under section "Development" (maybe "Testing" or "Continuous Integration").
@umarcor umarcor added the type-docs Issue is related to documentation. label May 18, 2022
@umarcor umarcor mentioned this issue Aug 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-docs Issue is related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant