Docs Contest: Enhance our Documentation and Win $300!

Hey Autonauts!

Grab the chance to win up to $300 USDC!

Docs PR

We are giving $250 for the best merged pull request enhancing our documentation. explore ‘good first issues’ in the documentation repos.

Your task? Submit a pull request that’s impactful, innovative, and high quality. Check out the criteria:

  1. Clarity: Simplify complex ideas.
  2. Relevance: Keep up with the latest in the Subspace community.
  3. Impact: Transform our docs, don’t just tweak.
  4. Innovation: Bring fresh and exciting ideas.
  5. Quality: Ensure technical accuracy, perfect grammar, and clean formatting.

Not sure how to make a change? Check out our guide here. If you’re not familiar with GitHub you should start with the Simple Fix section and work from there.

Need inspiration? Dive into the Autonomys Network Forum and Discord channels, or check the Issues page on our GitHub. Look for common problems, user issues, or hot topics.

Localization/Translation

As apart of our localization efforts, the entrant with the most Crowdin translations at the end of the month will also receive $50 USDC! That means you can win up to $300 USDC every month.

We have 17 languages available for translation, please check out our guide here for more info.

Check out the criteria:

  1. Accuracy : Try your best to convey the original message, style, and tone.
  2. Originality: Please avoid Google Translate and other AI services, we will be comparing to ensure the translations are not computer generated.

Details

The competition will be ongoing, and we’ll choose the winner at the end of each month in UTC Time.

Provide your Ethereum address with this submission form, and please read the doc below for terms & conditions.

:warning: Terms & Conditions:

Docs PR Contest T&C

63 Likes
  1. Increased Monthly Top Prize: The monthly top prize for the best merged PR, as voted by our team, has been raised to $250 :partying_face:.:sunglasses:
  2. Contest Expectations: The Subspace team does not expect transformational updates to the docs through this contest, but rather incremental tightening and alignment.
  3. Larger Projects: If you have ambitious ideas for the docs, please reach out to us. Bounties and grants can be discussed with the team! :exploding_head:

Thank you for contributing to our community and improving our documentation! :rocket:

20 Likes

:tada::balloon: gvzdv conquers the July Doc Contest! Could YOU Be August’s Winner?:balloon::tada:

We’re thrilled to celebrate our winner in the July Documentation Contest: gvzdv , scoring an impressive $250 top prize for July! :trophy:

But wait, there’s more! We want YOU to join in the August Docs Contest and here’s why:

  • :moneybag: Winning $250 is Easy! gvzdv proved that transformational changes aren’t needed; incremental improvements can lead you to victory! :partying_face:
  • :exploding_head: Have Bigger Ideas? Reach out! We’re all ears for ambitious projects, and bounties. Grants are on the table.
  • :medal: Everyone’s a Winner! Whether you win or not, everyone who enters will receive a unique Subspace POAP

Winning Submission: Safety and Security Guide by gvzdv · Pull Request #188 · subspace/subspace-docs · GitHub

23 Likes

The results for the August Docs contest are in! :tada:

We’re excited to announce that extSunset is our August winner for his impressive PR that automated the generation of the docker-compose file!
He will be receiving $250 USDC for his contribution.

Full list of all contributions in August!

  1. PR 200 that added a link to community-run subreddit.
  2. PR 204 that renamed all instances of Simple CLI and introduced Pulsar
  3. PR 209 that renamed instanced from Gemini 3e to Gemini 3f and made formatting improvements
  4. PR 211 that added some warning about LLVM and Clang 16
  5. PR 208 that updated tmux commands
  6. PR 207 that updated information and warnings about filesystems
  7. PR 212 that automated the generation of docker-compose file
  8. PR 226 that fixed issues with docker file indentation
  9. PR 227 that fixed regex issues with docker file generator
  10. PR 231 that removed some parts from a docker file when they weren’t needed
  11. PR 234 that fixed codeblocks
  12. PR 233 that updated our color palette
  13. PR 235 that updated the start instructions for the docker file

Think you have what it takes? Dive into our Issues page, pick an unassigned issue, and help us transform Subspace!

To enter, don’t forget to fill out the docs contest google form.

Thank you to everyone who participated! Let’s make September even better! :rocket::book:

12 Likes

:jack_o_lantern: October Docs Contest Special! :jack_o_lantern:

It’s getting spooky!!! :scream:

The September Docs prize has rolled over to October, creating a grand prize of $500 for the best merged PR.

Every valuable contribution earns a unique Subspace POAP.

:mag: Need direction? Refer to our guide or seek out good first issues on Github.

Stay Updated with our Weekly Sessions! :date:

Join Developer Office Hours (DOH) or Farmer Office Hours every Wednesday on Discord to be the first to learn about these contests and more.

Be sure to fill out this submission form

11 Likes

We’re happy to announce the winner of the October docs contest: SethY8s, who implemented a search bar for Subnomicon. Congratulations—the spooky reward of $500 is yours!

We really appreciate all contributions and will distribute a POAP to each contributor this week. Make sure to check your emails!

Here’s the full list of PRs that participated in the contest:

  1. PR 271 by extSunset. An excellent guide on setting up a systemd service on Linux systems.
  2. PR 264 by hairtail that fixed a broken link.
  3. PR 267 by hairtail that corrected the ordered list letters.
  4. PR 285 by skylordafk, who completed an almost complete rewrite of the Pulsar guide, turning it into both a quick start and a step-by-step tutorial.
  5. PR 12 by SethY8s, who implemented search functionality for Subnomicon.
  6. PR 6 Ukrainian translation for the block explorer and faucet.
  7. PR 7 Ukrainian translation for the introduction page.
  8. PR 8 Translations for CrowdIn to Ukrainian.
  9. PR 9 Ukrainian translation for Contribute.md and the Code of Conduct.

Friendly reminder: This is an ongoing contest, and we’re now accepting submissions for November. Help us improve our documentation and get a chance to win 250 USDC!

6 Likes

:turkey: Thanksgiving Docs Contest :turkey:

:maple_leaf: In this season of giving, we’re giving out $250 USDC to the best documentation pull request!

Win $250 USDC and buy a lavish Thanksgiving feast or gifts for loved ones!

Contributions to the following initiatives are eligible for this contest, explore the ‘good first issues’ in these repos

Every entry earns a unique Subspace POAP.

:writing_hand: Remember to submit your entry using this form

8 Likes

The winner for the November docs contest and $250 USDC is…

Mathematicw :trophy:, for adding great info on fraud server protection and general security measures!

We will be distributing a POAP for all participants, please make sure to fill out this form if you haven’t already so we can send the mint link to you.

There are 13 contributions eligible for the documentation contest.

  1. Mathematicw PR 318 that added a link to the forum in the intro page
  2. Mathematicw PR 314 that added tons of useful information on general security measured and fraud server protection.
  3. Mathematicw PR 325 that made a bunch of updates for the advanced CLI. A lot of changes didn’t make it to the merge because of the docs refactor, but initial PR was introducing some massive useful changes.

Crowdin contributions:

  1. megamozg Ukrainian 1541 words
  2. Fan MOZG (kievmozg) Ukrainian1541 words
  3. Scorpio2017 Russian 1437 words
  4. Tech Web3 (web3crypto) Ukrainian 1300 words
  5. Wedding Eknopka (cryptan) Ukrainian1286 words
  6. Dima Zadorozhny (Dmitryzd) Russian 878 words
  7. Yurii Bukshuk (Yurally) Ukrainian 587 words
  8. Nirnaeth (nirnaeth-arnoediad) Turkish 492 words
  9. Farzad Karimnejad (Shassi) Turkish 837 words
  10. Кирилл Троян (PurpleMoney) Russian 383 words

Thanks everybody for participating and remember to always fill out the form to enter. This contest is ONGOING, so look out for a special edition December docs contest…

9 Likes

In the spirit of the festive season, we’re excited to announce a special Christmas-themed USDC giveaway! You can win up to $300 USDC!:christmas_tree::gift:

Win $250 USDC for the best merged documentation pull request!!:santa:

This contest welcomes contributions to the following areas, where you can find ‘good first issues’ to tackle:

Surprise!!! The entrant at the top of the translation leaderboard on Crowdin at the end of the month will receive an additional prize of $50 USDC!

For more info check out the following post :star2:

Every participant will receive a unique Subspace POAP as a token of appreciation.

:writing_hand: Remember to submit your entry using this form or your submission will not count!

13 Likes

:trophy: December’s Docs Contest Winners Are Here!

:tada: Let’s give a big round of applause to MathematicW for their outstanding contribution in the PR 383!

This incredible addition covers everything from partitioning schemes to file system creation and mounting options. MathematicW, your input is invaluable! As a token of our appreciation, you’ve earned 250 USDC!

:star2: Not stopping there, our amazing translators collectively contributed over 20,000 words across 4 languages!

Zulkis took the lead, translating more than 11,000 words! Zulkis, your dedication is commendable, and you will receive a well-deserved reward of 50 USDC for your efforts!

:gift: For all participants, get ready for your POAP! Haven’t filled out the form yet? Don’t miss out on your special badge! Fill out the form here to receive your mint link.

:rocket: Remember, our Documentation Contest is ongoing, offering $250 for the PR of the month and an additional $50 for the top translation in January 2024! Looking forward to seeing your contributions!

10 Likes

New Year, New Documentation Contest! Win up to $300 USDC!

:trophy: Top Prize: $250 USDC for the best merged documentation pull request! :books:

This is your chance to contribute to key areas such as:

And there’s more! The person with the most translations on Crowdin by the end of the month wins an extra $50 USDC! :earth_africa:

For more info check out the following post :star2:

Every participant will receive a unique Subspace POAP as a token of appreciation.

:writing_hand: Remember to submit your entry using this form or your submission will not count!

9 Likes

February Docs Contest :two_hearts:

It’s that time of the year :kissing_heart:…I’m smelling some love in the air :smiling_face_with_three_hearts:

Enter our docs contest to win $300 and buy your loved one a well-deserving gift! :heart_eyes:

:trophy: Top Prize: $250 USDC for the best merged documentation pull request! :books:

This is your chance to contribute to key areas such as:

And there’s more! The person with the most translations on Crowdin by the end of the month wins an extra $50 USDC! :earth_africa:

For more info check out the following post :star2:

Every participant will receive a unique Subspace POAP as a token of appreciation.

:writing_hand: Remember to submit your entry using this form or your submission will not count!

13 Likes

Congratulations to Feb Docs Contest Winners :heart_eyes:

Zulkis (aka RomanLabGit) is awarded $250 USDC for PR 430 :kissing_heart:

Dmitryzd is awarded $50 USDC for translation efforts :two_hearts:

Shoutout to all the PR’s submitted:

  1. PR 423 by Qwinn1 that adjusted and fixed the systemd commands.
  2. PR 425 by Qwinn1 that updated ufw rules on network and security pages (initially discussed on Discord)
  3. PR 424 by Qwinn1 that followed the Discord discussion and fixed the filesystems recommendation and warnings (Cow systems, ext4, RAID etc)
  4. PR 430 by Zulkis that is sistered Zulkise’s custom dashboard and monorepo conbribution and added a simple guide on setting up a custom Grafana Dashboard
  5. PR 450 by Zulkis that updated the dev docs (RPCs) and fixed some typos

This contest is ongoing! Keep an eye out for the March Docs Contest!

1 Like

:four_leaf_clover: March Madness Docs Contest! :four_leaf_clover:

Get ready for an exciting month of March! Dive into our documentation contest and snag your pot of gold worth $300 USDC!

:trophy: Top Prize: $250 USDC for the best merged documentation pull request! :books:

This is your chance to contribute to key areas such as:

Subnomicon Documentation

Official Documentation

And there’s more! The person with the most translations on Crowdin by the end of the month wins an extra $50 USDC! :earth_africa:

Localization on Crowdin

For more info check out the following post :star2:

Every participant will receive a unique Subspace POAP as a token of appreciation.

:writing_hand: Remember to submit your entry using this form or your submission will not count!

1 Like

I translated a large amount of document content into Chinese quite early on, but it has not been deployed to the official website for a long time.

1 Like

:trophy: Congratulations to the March Madness Docs Contest Winners! :four_leaf_clover:

We’re thrilled to announce that @ImmaZoni has won $250 USDC for their outstanding contribution implementing Algolia Search into the Docs : Subspace Docs Update PR #462.

Shout-out to Zulkis for winning first place once again in our translations efforts!

The team acknowledges the CrowdIn technical difficulties this month, but rest assured we resolved them! We will also be deploying more of our community translations as they trickle in!

1 Like

April Docs Contest – Not a Prank!!!

:joy:We’re giving away $300 USDC AND it’s not an April Fools prank!!! :rofl:

:trophy: Top Prize: $250 USDC at the end of April for the best merged documentation pull request! :books:

This is your chance to contribute to key areas such as:

Subnomicon Documentation

Official Documentation

And there’s more! The person with the most translations on Crowdin by the end of the month wins an extra $50 USDC! :earth_africa:

Localization on Crowdin

For more info check out the following post :star2:

Every participant will receive a unique Subspace POAP as a token of appreciation.

:writing_hand: Remember to submit your entry using this form or your submission will not count!

2 Likes

all good i like this project and remember my name

:trophy: Congratulations to the April Docs Contest Winners!

We’re thrilled to announce that @RomanLab has won $250 USDC for their contribution to the Docs : Subspace Docs Update PR #505 .

Shout-out to @Hendot for winning first place in our translations efforts!

Congratulations to all the winners! :hugs:

Pausing the Monthly Docs Contest

The Documentation Contest will be paused until further notice. Over the past months, your contributions have significantly enhanced our documentation, allowing us to reach a good, stable state with our materials.

With the documentation now being robust and no longer subject to critical changes, we’ve decided to pause this contest until further notice. But don’t fret, we have here more contests!

Other Contests Still Ongoing

Docs Contest Statistics and Recognition:

  • Total Contributions: 45
  • This initiative has not only improved our documentation quality but has also stabilized the foundational knowledge for our community and new users.

Honorable Mentions:
We would like to extend our special thanks to contributors who have made remarkable impacts:

  • seryoga_leshii
  • MathematicW
  • gvzdv
  • romanlabgit (aka Zulkis)
  • Qwinn1

Your hard work and dedication have been instrumental in this achievement. We still welcome and value any updates and improvements you wish to make to the docs repo.

5 Likes