Feature Request - ability to pick up icons present in local path

[manojlds]

It's going to be a never-ending process of adding new icons. Has there been talk of supporting custom icons, possibly taken from some local path via convention or configuration.

This will also allow us to use internal product icons in the diagrams as well.

[gabriel-tessier]

Hi @manojlds

There's already a custom class check about in this issue:
#22

Look like there's no example in the doc.
@mingrammer
I didn't found any reference to custom in the doc or example page if it's ok I can push a PR with an example.

[mingrammer]

There is already an example for the custom node.

But it can be difficult to find as you have been. @gabriel-tessier It would be good to introduce the custom node in the docs/guides/node page too. Could you please push a PR for it?

If you are ok, I'll assign this issue to you.

[gabriel-tessier]

@mingrammer

Ok, I'll give a try and push a PR this week.

[mingrammer]

Thank you! :)

[gabriel-tessier]

@mingrammer
Long long week... finally I had time to check about and I'm not 100% sure about, but I generate a doc page now just linking to the example.
I made a "apidoc_custom.tmpl" file, here also not sure if it's the best way to go and also I didn't get how to see the generated result and how to format all the contents.
Just to confirm if I'm doing the things correctly.
If you can provide some direction it will be really helpful.
m(__)m

[wolfspyre]

ooh awesome! @mingrammer - @gabriel-tessier highlights a good point! might it be informative / helpful for future collaborators / worth your time to use this opportunity to create a ‘how to doc new features’ guide ? “... help me help you ...” you know? @gabriel-tessier - long week indeed, but it feels like 2020’s been full of those. nevertheless, thank you for helping out here! MobileMail

…

On Dec 5, 2020, at 02:42, gabriel-tessier ***@***.***> wrote:  @mingrammer Long long week... finally I had time to check about and I'm not 100% sure about, but I generate a doc page now just linking to the example. I made a "apidoc_custom.tmpl" file, here also not sure if it's the best way to go and also I didn't get how to see the generated result and how to format all the contents. Just to confirm if I'm doing the things correctly. If you can provide some direction it will be really helpful. m(__)m — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[mingrammer]

@gabriel-tessier Thanks for the work :) But the custom provider can cause confusion to contributors because it is not an actual provider. Can you generate the custom docs page without adding it to the provider list?

[gabriel-tessier]

@wolfspyre

might it be informative / helpful for future collaborators / worth your time to use this opportunity to create a ‘how to doc new features’ guide ?

There's already an issue: #108 and a PR #109

This one was focusing on how to build and install your environment, I think the Docker push #210 help to solve some installation problems.

So far what I did:

1. Adding icons: I think this one is fully documented and so far there's more than 50 different contributors that were able to do it, so I don't know if there's more to add.
2. Adding provider: This one may lack some documentation but I don't think it's really important as it's similar to add icons and strait forward, plus there's already several PR that can be checked to see where and what to change.
3. Making changes on website, here also there's documentation and it's not too complex only need to install npm and read how to write Markdown.

If you can provide more detail about where I can help (if I can) to make better doc. Better to open a new issue for this.

Sorry if I don't reply to your comment correctly or if I misunderstood.

[gabriel-tessier]

@mingrammer
If there's nothing else to add here can you close it, please.
I'll check if I can help working on another issue.

Thanks again for merging my PR.

m(__)m

[gabriel-tessier]

I think that everything is done here.