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

Help wanted #431

Open
jbomhold3 opened this issue Feb 19, 2021 · 7 comments
Open

Help wanted #431

jbomhold3 opened this issue Feb 19, 2021 · 7 comments
Labels
help wanted Extra attention is needed

Comments

@jbomhold3
Copy link
Collaborator

jbomhold3 commented Feb 19, 2021

Feel like getting involved?

Key Area to start with are:

  • Documentation
  • Performance
  • Unit Testing
@jbomhold3 jbomhold3 added the help wanted Extra attention is needed label Feb 19, 2021
@jbomhold3 jbomhold3 pinned this issue Feb 19, 2021
@Athira2199
Copy link

Hi would love to contribute. Please guide me on how to start contributing in the documentation section. @jbomhold3

@jbomhold3
Copy link
Collaborator Author

We need to start full outlining all parameters in components. What's required to be nested where. A better getting start guide. Do a review our of samples to make sure they are clear enough that someone can look at the docs and know exactly how things are working. In general ATM our docs are just a collection of snippets that does not really explain anything. I think we could do a far better job at this. We also need to make sure we are using all our components in our examples like https://blazorstrap.io/tables for example does not every use and just defaults to the html tag. While is does work and is perfectly acceptable we do have the tag and never even bring up we have it. Wouldn't even mind seeing a details button on each page that links to a docs fx style brake down for everything.

@jbomhold3
Copy link
Collaborator Author

jbomhold3 commented Mar 25, 2021

Models for example do require the service to be used while other places don't. We can't keep assuming people are clicking the getting started first. So each area should be able to stand on it's own event if its just a heading that says hey it's very important for you to read ________ before continuing.

@Athira2199
Copy link

Hi @jbomhold3 got your point. So which would be the branch on which I should perform the changes. 1.0.0 dev ? Also could you specify the tool which you have used for documentation. It would be helpful for me to get started. As I am quiet new to this documentation scenario.

@jbomhold3
Copy link
Collaborator Author

Just base your branch off of master

@zandermar18
Copy link
Contributor

Any open bugs or new features you want a hand in writing?

@jbomhold3
Copy link
Collaborator Author

jbomhold3 commented Apr 10, 2022

@zandermar18 We have
#493 & #494 open atm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants