Docs: API reference for all components

[thatsamsonkid]

Which scope/s are relevant/related to the feature request?

Docs

Information

Need to add documentation to that outlines the api inputs and outputs for all the components in the library

Describe any alternatives/workarounds you're currently using

No response

I would be willing to submit a PR to fix this issue

• Yes
• No

[jackyshows]

@goetzrobin I can handle that.

Do you already have the list of API references for each component, or should I figure that out myself?
Additionally, do you have any recommendations for the graphics? My plan was to add the section under the "Examples" section, displaying the name of each input and its description in a table, similar to what Material does: https://material.angular.io/components/paginator/api.

[thatsamsonkid]

@jackyshows - Checkout this discussion for some more information on the display piece, #107. Also no api reference to easily look at unfortunately, so you will have to check each component out to figure it out for now. Would definitely appreciate a hand on this. I was originally going to do it but got sidetracked with some other things and just been a little low on time. We can definitely do an initial static documenting of the component API's but one thing I was thinking of if there was a way we could have api reference update dynamically like as part of the build or something. Just some food for thought, we don't necessarily need to figure that out as part of this ticket but just thought I would mention in case you might have any ideas while working on this.

Let me know if I can provide anything else, if not just thumbs up and I'll assign this to you

[jackyshows]

@jackyshows - Checkout this discussion for some more information on the display piece, #107. Also no api reference to easily look at unfortunately, so you will have to check each component out to figure it out for now. Would definitely appreciate a hand on this. I was originally going to do it but got sidetracked with some other things and just been a little low on time. We can definitely do an initial static documenting of the component API's but one thing I was thinking of if there was a way we could have api reference update dynamically like as part of the build or something. Just some food for thought, we don't necessarily need to figure that out as part of this ticket but just thought I would mention in case you might have any ideas while working on this.

Let me know if I can provide anything else, if not just thumbs up and I'll assign this to you

I read your message and the entire discussion. At the moment, I don't know a solution for automatically gathering all the API references. However, I can research and study this topic, as it's something I'd like to do.

In the meantime, I think we can start by building a "static" version. I noticed you've already started creating a mockup API section for testing purposes.

So, the question now is: how do we share the work we're going to do? Should we share a forked repository and commit all the changes there?

[thatsamsonkid]

@jackyshows - you can just start on your own branch in a forked repo. I really did not make much significant changes it was just some quick and dirty changes to see how each option would look roughly. I'm not sure if I still have that branch since it was a while ago but I can check if you really want it but I think you can just start from new.

[jackyshows]

@thatsamsonkid Don't worry about it; I'll start from a new branch. Based on the discussion #107, did I understand correctly that we should follow option B?

[thatsamsonkid]

@thatsamsonkid Don't worry about it; I'll start from a new branch. Based on the discussion #107, did I understand correctly that we should follow option B?

Yes most of us voted for option B, so lets go with that

[thatsamsonkid]

@jackyshows have you made progress on this? Else im considering splitting this to 1 or few components so it's easier to work on.

[IEdiong]

@jackyshows have you made progress on this? Else im considering splitting this to 1 or few components so it's easier to work on.

No response to this yet? @thatsamsonkid
What now?

[thatsamsonkid]

Ok I will unassign this issue for now. I think I will keep it more to confirm when we complete documenting all the components we have and lets create an issue for documenting each component. @IEdiong if you want pick a component you would like to help document and create an issue for it for now. Once we have the initial implementation I will create issues for documenting the rest of the components.

[thatsamsonkid]

I am retaking up this issue. Mainly because I think I got a semi decent implementation for auto generating the api docs from the code so it is not something we need to maintain separately.