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.

Sign up for GitHub

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

Jump to bottom

Rename "Developing" in docs to "Developer portal" #1881

Closed
paulproteus opened this issue Apr 20, 2016 · 0 comments
Closed

Rename "Developing" in docs to "Developer portal" #1881

paulproteus opened this issue Apr 20, 2016 · 0 comments

Comments

@paulproteus
Copy link
Collaborator

paulproteus commented Apr 20, 2016 •
edited
Loading

@jadeqwang and @neynah and I are interested in clarifying to website visitors that the Sandstorm developer docs are the best place to start when people want to find technical information about developing apps for Sandstorm. Given that, here are some next steps:

Sandstorm repo

  • Sandstorm GitHub README: Make it crisper; refer to developer portal
  • Adjust /developing/ to have a few icons at the top to other places. Mockup:

screenshot from 2016-04-18 13_48_47

sandstorm-website repo
paulproteus added a commit that referenced this issue Apr 21, 2016
@paulproteus
Add developer portal
f109ce0 
Close #1881

@neynah you probably want to do post-commit review of this.
paulproteus added a commit that referenced this issue Apr 21, 2016
@paulproteus
Add developer portal
2257cfa 
Close #1881

More specifically:

- Change mention of app developer tutorial in README to instead
  link to developer portal.

- Add a flexbox grid at the top of /developing/ for quick access
  icons to next steps, to make it feel more like a "developer
  portal" (cc: @jadeqwang), supported by `docs/extra.css`

While I was at it:

- Move the documentation explaining the vague overall design goals
  of `vagrant-spk` from `docs/vagrant-spk/index.md` into the existing
  file, `docs/vagrant-spk/customizing.md` which allowed me to delete
  `docs/vagrant-spk/index.md` entirely.

- Adjust the packaging tutorial to say that some parts might be slow
  due to download times.

- Drastically improve (in my opinion) the amount of information, and
  its contextualization, within the Developer Portal. Up until now,
  Cap'n Proto was not even mentioned once.

- Update commented-out TODO items to indicate that some docs have now
  been written.
@paulproteus paulproteus mentioned this issue Apr 21, 2016
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@paulproteus