singnet / dev-portal

The SingularityNET Developer Portal where you can find all our documentation, tutorials, and developer resources!
https://dev.singularitynet.io
118 stars 57 forks source link

"Edit" button, TODO and similar things on the pages of Dev Portal (enhancement / bug) #78

Open rustam-RI opened 5 years ago

rustam-RI commented 5 years ago
  1. You can see "Edit" button on this page for example https://dev.singularitynet.io/docs/setup/

I suppose that this button is present here just for the convenience of developers, like to have a possibility to quickly switch to the source of the page. If it's correct then ofc I think that it would be better to finish some related works soon and to remove this button. Because as I understand it's not necessary for the users and the portal should be perceived as some finished product in my view. Although it's totally ok to update the info iteratively and to extend it later.

  1. I can see some "TODO" blocks, for example, on that page https://dev.singularitynet.io/docs/setup/call-a-service/ I guess it's the similar issue as with "Edit" button So these blocks indicate for the developers that something is "to be completed" later But as I remember the developer portal is live for 6 months so I suppose that it's good to keep the pages without such blocks or make it a bit more accurate somehow Otherwise it produces an impression of some draft while the website is actually live and it's open to the public

  2. On that page https://dev.singularitynet.io/tutorials/sdk/ I can see such command with additional phrase pip install snet-sdk (check this is correct) So I guess it's the same situation here, it would be nice if such questions can be clarified and removed as soon as possible

ferrouswheel commented 5 years ago

Edit button was intentionally added #53

The goal was always for SingularityNET to be community orientated. It's not a final product but an evolving ecosystem, and we want to encourage a community and tooling that makes it easy for anyone to contribute (This is generally how open source works)

The TODO blocks definitely need to be filled in though!