Skip to content
This repository has been archived by the owner on Dec 13, 2018. It is now read-only.

Documentation & Sample application updates #166

Open
robertjd opened this issue Aug 8, 2016 · 0 comments
Open

Documentation & Sample application updates #166

robertjd opened this issue Aug 8, 2016 · 0 comments
Assignees
Labels

Comments

@robertjd
Copy link
Member

robertjd commented Aug 8, 2016

Hello all, this issue enumerates the improvements that I’d like to see to the documentation of this library. These are the tasks I would like to complete:

  • Remove the Yeoman Guide. I love Yeoman, but maintaining a working and up-to-date example requires a lot of maintenance.
  • The Angular SDK API Docs should become the primary documentation for this module. It’s quick start section can be used to show the difference between UI Router and ng-router configuration. Any other detail is already described in there, or shown by example in the Stormpath Angular + Express Fullstack Sample Project.
  • Remove the “dashboard-app”, and “ng-router” example applications from the examples/ folder, and start referencing the Stormpath Angular + Express Fullstack Sample Project as the primary example project for this library. As more examples come online, e.g. Spring + Angular, then we can link to them as well.
  • The CORS example can stay for now, and should be referenced from the main page of the API documentation. We get a lot of CORS question so this example is useful.
  • Modify the README to be a jumping point, the README should be used to redirect you in one of the following ways:
    • Need docs? See the API Documentation
    • Want to see it working? Check out the sample application(s)
    • Integrating it into an existing application? See the API Docs, and use the SPA Dev Sever to demo the JSON API from our framework integrations.
    • Support channels
  • Create a landing page at docs.stormpath.com/angular which also serves as the same jumping point.
  • Update the server integration guide, as this information was written before we had the framework spec: https://docs.stormpath.com/angularjs/sdk/#/server
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

1 participant