Update pulsar.mdx #285

skylordafk · 2023-10-14T01:43:46Z

Reorganized page into Quick Start, Troubleshooting and Advanced Settings sections. Reformatted the warnings into dropdowns (at least I tried to) and changed some wording across the guide to hopefully be more clear for first-time users. This was thrown together pretty quickly, so I hope you'll share feedback with me on what you like and how to improve.

netlify · 2023-10-14T01:43:49Z

👷 Deploy request for subspace-docs-staging accepted.

Name	Link
🔨 Latest commit	`c3307fb`
🔍 Latest deploy log	https://app.netlify.com/sites/subspace-docs-staging/deploys/65333d273232f8000806cc8d

EmilFattakhov

Awesome suggestions @skylordafk! I think it's a step in the right direction, definitely making Pulsar documentation more user-friendly.

Left a few suggestions in the comments, please let me know if anything is unclear.
Looking forward to the update and getting this PR merged 🚀

EmilFattakhov · 2023-10-17T01:56:31Z

versioned_docs/version-latest/protocol/pulsar.mdx

@@ -41,12 +34,24 @@ Pulsar requires commodity hardware specs to operate. At a **minimum**, it is rec
 | SWAP     | 4GB              |
 | Storage  | 100GB SSD        |

-:::note SWAP Warning
-A swap is only necessary if you have a low amount of RAM. 
+:::caution


I think it's a good idea to keep all warnings and cautions visible (without having to click on a dropdown), just to make sure users read them before proceeding to the steps below.

I like your idea and potentially in the future it would be good to just have a quick start right away, but not at this point.

Okay that's interesting. First of all, thanks for reviewing all of these changes! I realize now that there's a lot mushed into one pull request haha.

About this change -- these warnings seemed totally irrelevant to me starting up on my consumer hardware, which is why I hid them. But I totally get wanting them displayed prominently so that the people that they are relevant to, have no chance of missing them. I will revert them back.

You are spot on, thank you, Skyler!

EmilFattakhov · 2023-10-17T01:58:22Z

versioned_docs/version-latest/protocol/pulsar.mdx

 :::

-:::note CoW Filesystems Warning
-It is advised not to use the Subspace farmer and node on CoW file systems for any OS (ReFS, BTRFS, ZFS, bcachefs, HAMMER and some more).
+<details>


I'd suggest removing all new tags and keeping it "spammy", but visible.

If I understand correctly, the preferred display of the warnings is to keep them how they were. I have no problem with that.

versioned_docs/version-latest/protocol/pulsar.mdx

EmilFattakhov · 2023-10-17T02:01:10Z

versioned_docs/version-latest/protocol/pulsar.mdx

 :::
 <details>
  <summary>
-  Prefer A video? Expand for our installation video
+  Prefer a video? Expand this section to view an installation video


an installation video -> the installation video.

EmilFattakhov · 2023-10-17T02:02:43Z

versioned_docs/version-latest/protocol/pulsar.mdx


 <Tabs groupId="OS">

 <TabItem value="windows" label="🖼️ Windows" default>

 :::caution

-Some older processors/VMs are no longer supported by official releases, but can still be compiled manually if desired
+Some older processors/VMs are no longer supported by official releases, but can still be compiled manually.


What do you think about making compiled manually a link here to the "how to compile manually" section?

Great idea -- I personally came across a suggestion to compile manually in the forum and didn't know where to start. I found this link on the Local Development page and will use that unless you suggest otherwise.

Yes, that's the right one!

EmilFattakhov · 2023-10-17T02:08:29Z

versioned_docs/version-latest/protocol/pulsar.mdx

@@ -469,7 +404,111 @@ Initial plotting for plot: #0 (/home/username/.local/share/pulsar/farms)

 That's it! Enjoy and Happy Farming!

-#### Moving the Farming Process to the Background
+
+## Troubleshooting


Love the idea of moving all this stuff to the section at the bottom to keep the quick start simpler 🤟

EmilFattakhov · 2023-10-17T02:09:36Z

versioned_docs/version-latest/protocol/pulsar.mdx

+
+
+
+## Still having trouble with your farmer?


Let's make it a subsection of troubleshooting by using ### instead.

EmilFattakhov · 2023-10-17T02:10:13Z

versioned_docs/version-latest/protocol/pulsar.mdx

+
+## Still having trouble with your farmer?
+
+If you are facing issues with your node/farmer you can try a few of the following things below, if you are unable to get your issue resolved please check our [Forums](https://forums.subspace.network) to see if your issue may have been solved, if its a new one feel free to post it! You can also join our [Discord](https://discord.gg/subspace-network) for additional Peer to Peer help.


Forums -> forum

EmilFattakhov · 2023-10-17T02:15:40Z

versioned_docs/version-latest/protocol/pulsar.mdx

+If you're connected directly without any router, then again nothing needs to be done in such case.
+
+
+### View your Logs


While we're here, let's rename it something like Inspecting logs. Feel free to suggest some other name, but View your Logs sounds a bit out of place.

Agreed, inspecting logs sounds better here.

I kind of like Inspecting Farmer Logs? Hmm. If you think of something better we can die on this hill haha. These things are important 😄

Definitely!
I'd suggest to not use a word "Farmer", since Pulsar combines the logs of both Node and Farmer.

Reverted the "Swap, Cow, Redundancy, Chunk" warnings and some wording to their original state. Fixed Header formatting. Changed some wording per Emil's suggestion. Added two links pointing towards "compile manually" guide.

skylordafk · 2023-10-19T03:48:03Z

Alright, that was helpful feedback. Hopefully I fulfilled your wishes with this latest change. Let me know what else I can do!

EmilFattakhov

This is looking great @skylordafk, thank you for implementing my suggestions!

One final renaming suggestion and we should be good to merge!

versioned_docs/version-latest/protocol/pulsar.mdx

Co-authored-by: Emil Fattakhov <66026548+EmilFattakhov@users.noreply.github.com>

skylordafk · 2023-10-21T02:53:57Z

Fair point. Just committed the change. Thanks, Emil!

EmilFattakhov · 2023-10-23T02:43:15Z

Thank you @skylordafk for the great idea and it's implementation! Looking forward to seeing more PRs coming from you.
And don't forget to fill in the form if you haven't already :)

EmilFattakhov self-requested a review October 16, 2023 01:48

EmilFattakhov requested changes Oct 17, 2023

View reviewed changes

skylordafk marked this pull request as draft October 19, 2023 02:47

Update pulsar.mdx

e5d5f1c

Reverted the "Swap, Cow, Redundancy, Chunk" warnings and some wording to their original state. Fixed Header formatting. Changed some wording per Emil's suggestion. Added two links pointing towards "compile manually" guide.

skylordafk marked this pull request as ready for review October 19, 2023 03:43

EmilFattakhov requested changes Oct 20, 2023

View reviewed changes

versioned_docs/version-latest/protocol/pulsar.mdx Outdated Show resolved Hide resolved

EmilFattakhov and others added 2 commits October 20, 2023 10:53

Merge branch 'main' into patch-2

38bfb5a

Update versioned_docs/version-latest/protocol/pulsar.mdx

c3307fb

Co-authored-by: Emil Fattakhov <66026548+EmilFattakhov@users.noreply.github.com>

EmilFattakhov merged commit e7f7e67 into subspace:main Oct 23, 2023
2 of 4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update pulsar.mdx #285

Update pulsar.mdx #285

skylordafk commented Oct 14, 2023

netlify bot commented Oct 14, 2023 •

edited

EmilFattakhov left a comment •

edited

EmilFattakhov Oct 17, 2023

skylordafk Oct 19, 2023

EmilFattakhov Oct 19, 2023

EmilFattakhov Oct 17, 2023

skylordafk Oct 19, 2023

EmilFattakhov Oct 17, 2023

EmilFattakhov Oct 17, 2023

skylordafk Oct 19, 2023

EmilFattakhov Oct 19, 2023

EmilFattakhov Oct 17, 2023

EmilFattakhov Oct 17, 2023

skylordafk Oct 19, 2023

EmilFattakhov Oct 17, 2023

EmilFattakhov Oct 17, 2023

skylordafk Oct 19, 2023

skylordafk Oct 19, 2023

EmilFattakhov Oct 20, 2023

skylordafk commented Oct 19, 2023

EmilFattakhov left a comment

skylordafk commented Oct 21, 2023

EmilFattakhov commented Oct 23, 2023


		## Still having trouble with your farmer?

		If you are facing issues with your node/farmer you can try a few of the following things below, if you are unable to get your issue resolved please check our [Forums](https://forums.subspace.network) to see if your issue may have been solved, if its a new one feel free to post it! You can also join our [Discord](https://discord.gg/subspace-network) for additional Peer to Peer help.

		If you're connected directly without any router, then again nothing needs to be done in such case.


		### View your Logs

Update pulsar.mdx #285

Update pulsar.mdx #285

Conversation

skylordafk commented Oct 14, 2023

netlify bot commented Oct 14, 2023 • edited

👷 Deploy request for subspace-docs-staging accepted.

EmilFattakhov left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skylordafk commented Oct 19, 2023

EmilFattakhov left a comment

Choose a reason for hiding this comment

skylordafk commented Oct 21, 2023

EmilFattakhov commented Oct 23, 2023

netlify bot commented Oct 14, 2023 •

edited

EmilFattakhov left a comment •

edited