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

Documentation - Revamp README.md #308

Open
6 tasks
huntharo opened this issue Feb 11, 2023 · 1 comment
Open
6 tasks

Documentation - Revamp README.md #308

huntharo opened this issue Feb 11, 2023 · 1 comment
Milestone
v0.4

Comments

@huntharo
Copy link
Collaborator

huntharo commented Feb 11, 2023 •
edited
Loading

Motivations

  • The project has completely evolved from the original documentation, most of which no longer applies
  • The project has reached a useful state and should be documented to attract usage

To-Do

  • Create docs directory
  • Focus the primary README.md on: problem being solved, unique features / benefits, architecture overviews, and videos demonstrating usage
  • Link out to additional documentation for:
    • How to deploy the infrastructure
    • How to deploy first app
    • Advanced routing features
@huntharo huntharo added this to the v0.4 milestone Feb 11, 2023
@huntharo huntharo moved this to Todo in MicroApps Core Feb 11, 2023
@huntharo
Copy link
Collaborator Author

huntharo commented Mar 4, 2023

A portion of this was handled in #312 cleanups to the README

@huntharo huntharo moved this from Todo to In Progress in MicroApps Core May 20, 2023
@huntharo huntharo moved this from In Progress to Todo in MicroApps Core Apr 26, 2024
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
MicroApps Core
Status: Todo
Milestone
v0.4
Development

No branches or pull requests
1 participant
@huntharo