elsa-workflows / elsa-workflows/elsa-core

Feature request - XML comments for intellisense

Open
#2,910 0 comments 1 reaction 0 assignees View on GitHub
documentation triaged
Dominant language
C#
Stars
7.9k
Forks
1.5k
Avg merge
15h 22m
Merged PRs (30d)
114

Description

XML Comments for intellisense.

Currently to figure out what a method does I have to:

- Hope its in the docs
- Hope its in a guide
- Hope its in a sample (many samples/guides have very helpful comments in them)
- Launch Elsa Dashboard and read the comments in different UI screens
- Finally, read the source code

## No intellisense/XML comments screenshot

![image](https://user-images.githubusercontent.com/2934507/161306724-0396156f-66bd-4857-99c2-f2ee3268704a.png)

## Very helpful info, in UI

![image](https://user-images.githubusercontent.com/2934507/161307290-9bcb6b1e-316f-4104-96b1-cc3bbf56893d.png)

Also, I used a google site search `site:https://elsa-workflows.github.io "singleton"` and found AsSingle is documented, but on a hidden page:

https://elsa-workflows.github.io/elsa-core/docs/guides/guides-recurring-task

VS

https://elsa-workflows.github.io/elsa-core/docs/guides/guides-recurring-tasks

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.