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.

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

Documentation enhancements #207

Open
2 of 4 tasks
jsimck opened this issue May 22, 2022 · 0 comments
Open
2 of 4 tasks

Documentation enhancements #207

jsimck opened this issue May 22, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jsimck
Copy link
Contributor

jsimck commented May 22, 2022

Below is a list of things that are currently missing from the documentation. It would be nice to have at least some information about following topics in the future:

Current version

  • Apart from the generated documentation, there is no info on how to use the HttpAgent. It would be nice to write up small article on how to use the HttpAgent to fetch data, since it is usually the first thing you want to do in any web application.

Next

  • No info about @ima/cli -> small summary of available commands and their arguments should be sufficient.
  • Describe new webpack-related features (direct asset imports in code, built-time runner generation, ima.config.js, customization options, CLI plugins and config override options, glob imports in LESS, experiments)
  • Static assets definition in environment.js (JS & CSS) and how to inject them into DocumentView/SPA.html

This list will probably be updated overtime as new features are implemented or existing issues are already resolved.

@jsimck jsimck added the documentation Improvements or additions to documentation label May 22, 2022
@jsimck jsimck pinned this issue May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant