Skip to content
New issue

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

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

Already on GitHub? # to your account

DP: New sitemap #360

Closed
4 tasks done
relativityboy opened this issue Oct 29, 2018 · 5 comments
Closed
4 tasks done

DP: New sitemap #360

relativityboy opened this issue Oct 29, 2018 · 5 comments
Assignees
Labels
13 - SW Steemworks Points spike

Comments

@relativityboy
Copy link
Contributor

relativityboy commented Oct 29, 2018

The amount of information on the devportal has increased dramatically since the last time the site map was updated. As a developer I want to be able to find the information I need quickly and with ease so that I can learn and solve my business's problems with Steem.

Consider

  • Steem Basics section
  • Improved Getting Started section
  • Steemit specific section (with steemit resources, etc?)

AC

  • create a new sitemap that makes it easier for new users, business users, and experienced devs to get the information they need quickly.
  • communicate changes publicly and to all teams
  • incorporate internal and community feedback.
  • in # Results comment describe the above
@relativityboy relativityboy added spike 13 - SW Steemworks Points labels Oct 29, 2018
@TimCliff
Copy link
Contributor

A few suggestions:

  • The introduction page should clearly and concisely tell a new visitor where to go to find whatever they are looking for.
  • I suggest removing the "Quick Start" section and just making sure all of the necessary information that a visitor needs to find what they need is in the introduction section.
  • The "AppBase API" section should be renamed to "Blockchain API"
  • There should be a section for steemd nodes, which includes: Information on connecting to public nodes, instructions for launching private nodes, all documentation for steemd node operation including configuration values.
  • There should be a "Libraries" section where developers can find documentation for whichever libraries they want to use (Steem-JS, SteemPython, SteemRuby, etc.)
  • There should be a new section for "Testnet"
  • The "Sharing & Help" information should be renamed to "Developer Help" and should be it's own section.
  • It would be nice if going to sections like the current introduction page didn't require two clicks to get to the page (Introduction -> Welcome to Steem).

@relativityboy relativityboy self-assigned this Nov 8, 2018
@relativityboy
Copy link
Contributor Author

relativityboy commented Nov 16, 2018

Results

(sitemap w/very high level desc only. not paint)

  • INTRODUCTION
    • Splash page. Featured content. Details in different story.
  • GETTING STARTED
    What do you want to do? (A section has many links to other parts of the site)
    • LEARN BASIC STEEM CONCEPTS (baby recipes section - new super basics)
    • APP DEVELOPER (js / py / ruby)
    • HOST A STEEM NODE
    • SOLVE A MORE COMPLEX PROBLEM (recipes)
    • SOLVE A BUSINESS PROBLEM (new section)
  • TUTORIALS
    Like current. js / py / rb
  • TESTNET
    what is a testnet, list of steemit testnets & purpose, accessing with libs, firing up a node, launching your own
  • STEEMD
    optional - launch a steemd node. why
  • SERVICES
    Clean this section up. Standardize presentation. Description of each and that devs are encouraged to host their own and why. (Possible links to 00 recipe described below)
  • RECIPES
    Moved from TUTORIALS. Otherwise Like current, but new 00 recipe that describes the typical stages an application will go through, and the resources / app stack they might use in each stage. Also has 'baby' section.
  • API
    As is
  • PUBLIC NODES
    List of public steem nodes. (move from other section on current site)
  • HIVEMIND
    optional depending on outcome of various things, description of it, how to use it. Link to all different locations where it's used. Encouragement to develop with it and contribute source code to it.
  • RESOURCES
    As is. Has llbs & tools
  • EXCHANGES
    Guide exchanges through the process of setting up, incl some recommended processes for account creation if they're going to do that, and tools they should use for it.
  • GLOSSARY
    As is

Footer may have DA contact information, discord link, etc.

@roboza
Copy link
Contributor

roboza commented Nov 16, 2018

I like it. I think you have broken it up into more logical sections. Will be easier to find stuff.

@inertia186
Copy link
Contributor

This is perfectly cromulent.

@relativityboy
Copy link
Contributor Author

Calling this acceptable.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
13 - SW Steemworks Points spike
Projects
None yet
Development

No branches or pull requests

4 participants