# Comments in Github?

**URL:** <https://discourse.nodered.org/t/comments-in-github/57499>\
**Category:** General\
**Created:** [30 January 2022 13:00 UTC](https://discourse.nodered.org/t/comments-in-github/57499 "2022-01-30T13:00:10Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![solarslurpie](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/solarslurpie/32/46840_2.png) [@solarslurpie](https://discourse.nodered.org/u/solarslurpie)\
**Post date:** [30 January 2022 13:00 UTC](https://discourse.nodered.org/t/comments-in-github/57499/1 "2022-01-30T13:00:10Z")

</div>

I want to put documentation on each flow within a comment node and then have the documentation also show up in GitHub. I note I can evolve the Readme.md from within nodered (but even that seems to be one way. If I change the readme.md within GitHub and then pull to nodered, the readme in nodered does not update).

Is it possible to at least get to a URL where the comment node puts the text so that this could be used within a Github readme page?

Thank you.

---

<div class="post-metadata">

**Author:** ![Colin](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/colin/32/17040_2.png) [@Colin](https://discourse.nodered.org/u/Colin)\
**Post date:** [30 January 2022 13:35 UTC](https://discourse.nodered.org/t/comments-in-github/57499/2 "2022-01-30T13:35:57Z")

</div>

> [@solarslurpie](#):
>
> If I change the readme.md within GitHub and then pull to nodered, the readme in nodered does not update).

What do you mean by 'pull to node-red' and where are you seeing the readme within node-red?

---

<div class="post-metadata">

**Author:** ![knolleary](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/knolleary/32/3_2.png) [@knolleary](https://discourse.nodered.org/u/knolleary)\
**Post date:** [30 January 2022 13:40 UTC](https://discourse.nodered.org/t/comments-in-github/57499/3 "2022-01-30T13:40:18Z")

</div>

The readme is shown in the project settings dialog as the description of the project.

@solarslurpie If there's an issue with things getting out of sync in the editor, or not refreshing properly, please raise an issue with details.

---

<div class="post-metadata">

**Author:** ![Colin](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/colin/32/17040_2.png) [@Colin](https://discourse.nodered.org/u/Colin)\
**Post date:** [30 January 2022 13:56 UTC](https://discourse.nodered.org/t/comments-in-github/57499/4 "2022-01-30T13:56:41Z")

</div>

> [@knolleary](#):
>
> The readme is shown in the project settings dialog as the description of the project.

Ah, using the projects feature. I was in the wrong context.

---

<div class="post-metadata">

**Author:** ![solarslurpie](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/solarslurpie/32/46840_2.png) [@solarslurpie](https://discourse.nodered.org/u/solarslurpie)\
**Post date:** [30 January 2022 14:43 UTC](https://discourse.nodered.org/t/comments-in-github/57499/5 "2022-01-30T14:43:34Z")

</div>

@Colin Thank you. Re: raise an issue. Do you mean within a GitHub (so i should google nodered github and submit a PR?).

What about the text within a Comment node? Is it possible to have it sync'd / read within a GitHub such that a person does not need to install the flow before seeing the text?

Thank you.

---

<div class="post-metadata">

**Author:** ![Colin](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/colin/32/17040_2.png) [@Colin](https://discourse.nodered.org/u/Colin)\
**Post date:** [30 January 2022 14:59 UTC](https://discourse.nodered.org/t/comments-in-github/57499/6 "2022-01-30T14:59:51Z")

</div>

> [@solarslurpie](#):
>
> Do you mean within a GitHub (so i should google nodered github and submit a PR?).
> 
> What about the text within a Comment node? Is it possible to have it sync'd / read within a GitHub such that a person does not need to install the flow before seeing the text?

You should have replied to @knolleary as those questions relate to his post. He should see this now as I have tagged him.

---

<div class="post-metadata">

**Author:** ![knolleary](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/knolleary/32/3_2.png) [@knolleary](https://discourse.nodered.org/u/knolleary)\
**Post date:** [30 January 2022 15:18 UTC](https://discourse.nodered.org/t/comments-in-github/57499/7 "2022-01-30T15:18:04Z")

</div>

If you are able to, an issue on [GitHub - node-red/node-red: Low-code programming for event-driven applications](https://github.com/node-red/node-red) to cover the scenario regarding the readme getting out of sync, that would be great. No worries if not, although I'm not likely to remember about it otherwise.

Regarding your questions about comment nodes - there is nothing built-in to the editor that will pull out text from the flow and add it to the readme.

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/1X/d073cd938eafa2e558d7c2cd59003b3ef4963033.png) [@system](https://discourse.nodered.org/u/system)\
**Post date:** [31 March 2022 15:18 UTC](https://discourse.nodered.org/t/comments-in-github/57499/8 "2022-03-31T15:18:56Z")

</div>

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.