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

CLI Documentation could be clearer on specific details #127

Open
1 of 3 tasks
achiurizo opened this issue Dec 6, 2022 · 4 comments
Open
1 of 3 tasks

CLI Documentation could be clearer on specific details #127

achiurizo opened this issue Dec 6, 2022 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@achiurizo
Copy link
Contributor

achiurizo commented Dec 6, 2022

  • I'd mention WiFi in networking specifically, it is known to get much less stable in typical consumer routers under load
  • macOS executables say "Intel" and "Apple M1", while it is not necessary M1 as there is M2 already; either call it "Apple Silicon" or "x86-64" and "aarch64"
  • similarly for Ubuntu, we have "Ubuntu Executable" and "Ubuntu Arch Executable" (which I understand what you meant, but doesn't make sense generally), I think it should also just be "x86-64" and "aarch64" and it'll be consistent with macOS
@achiurizo achiurizo added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 6, 2022
@achiurizo achiurizo added this to the v0.2.0 milestone Dec 6, 2022
@achiurizo achiurizo added the good first issue Good for newcomers label Dec 6, 2022
@jfrank-summit
Copy link
Member

@ozgunozerk is this still applicable?

@postmeback
Copy link
Contributor

postmeback commented Jul 26, 2023

2nd & 3rd point has been taken care of. But, I am still figuring out the 1st point. Can you guide me on this?

Update: #187 (review)

@ImmaZoni
Copy link
Contributor

Thanks for the contributions @postmeback 🙏

In regards to the 1st point, this is admittedly a moving target still. For context on our farmer we utilize a Decentralized Storage Network. Being a P2P network this has the potential to send large amounts of requests through the router causing performance degradation on some routers. (See this issue here: subspace/subspace#1227)

As you can see this issue has been closed, but due to the nature of P2P networks we still need to continue testing. For now it might be best to just explain this context and clarify the general warning for network incendivity.

We might include something mentioning older/less performant routers may have issues aswell.

Thanks again for your contributions, happy to assist in any way possible

@postmeback
Copy link
Contributor

@ImmaZoni , thanks for the reply.

Requesting the maintainers to update this issue accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
Status: No status
Development

No branches or pull requests

5 participants