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

docs(demo/readme): add a readme file for demo app #70

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

fffjacquier
Copy link
Collaborator

@fffjacquier fffjacquier commented Mar 4, 2022

The demo app could be documented in order for people using it to understand why and how to use it

Description

Created a easy to grasp README file

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Closes #66

@fffjacquier fffjacquier added 📖 documentation Improvements or additions to documentation 🧑‍⚖️ Tech review needed Pull Request is ready for review, let's go ! labels Mar 4, 2022
Comment on lines +14 to +15
- a register.config.ts in src/app
- a login.config.ts in src/app
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we shouldn't provide paths and file names, it may change


#### Link Styled Components

This page doesn't use any UI library.
Copy link
Collaborator

@hpierre74 hpierre74 Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one could argue styled-components IS a UI library

@hpierre74
Copy link
Collaborator

I think we should not be that specific about what's in there, probably a better approach would be to add some contextual info in the demo app code itself - some description on every pages would do the trick and we would change it when developing

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 🧑‍⚖️ Tech review needed Pull Request is ready for review, let's go !
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Create Readme for demo apps
3 participants