# Project documentation

**URL:** <https://community.weweb.io/t/project-documentation/7864>\
**Category:** Ask us anything\
**Created:** [March 31, 2024, 4:29pm UTC](https://community.weweb.io/t/project-documentation/7864 "2024-03-31T16:29:01Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![LivingStoneHgS](https://avatars.discourse-cdn.com/v4/letter/l/439d5e/32.png) [@LivingStoneHgS](https://community.weweb.io/u/LivingStoneHgS)\
**Post date:** [March 31, 2024, 4:29pm UTC](https://community.weweb.io/t/project-documentation/7864/1 "2024-03-31T16:29:01Z")

</div>

Hi there,

I’m thinking a bit how I could document my project, right into it. For example :

- Describe a variable
- Describe a workflow
- Describe a component, etc.

So that it would allow :

- To see these docstrings where this elements are defined (most basic feature)
- maybe, having a “Project documentation” tab in the UI to search for any docstring in the whole project (for example, see where a variable name is mentionned, or some #tags …). It could group the docstrings by the different elements that wear them, our rather group by page, by tag… 🤷‍♂️

and we can imagine much more from that.

Long live Weweb 💖

---

<div class="post-metadata">

**Author:** ![Alexis](https://sea2.discourse-cdn.com/flex016/user_avatar/community.weweb.io/alexis/32/13248_2.png) [@Alexis](https://community.weweb.io/u/Alexis)\
**Post date:** [April 3, 2024, 2:42pm UTC](https://community.weweb.io/t/project-documentation/7864/2 "2024-04-03T14:42:56Z")

</div>

That’s a great suggestion, I would love to have something like gdoc collaborative notes too, there is definitely a need for a built-in documentation feature 🙂

---

<div class="post-metadata">

**Author:** ![Philibert](https://avatars.discourse-cdn.com/v4/letter/p/ee7513/32.png) [@Philibert](https://community.weweb.io/u/Philibert)\
**Post date:** [April 10, 2024, 12:55pm UTC](https://community.weweb.io/t/project-documentation/7864/3 "2024-04-10T12:55:45Z")

</div>

I’d love this feature too !

---

<div class="post-metadata">

**Author:** ![mark](https://sea2.discourse-cdn.com/flex016/user_avatar/community.weweb.io/mark/32/4163_2.png) [@mark](https://community.weweb.io/u/mark)\
**Post date:** [April 11, 2024, 1:56am UTC](https://community.weweb.io/t/project-documentation/7864/4 "2024-04-11T01:56:57Z")

</div>

This would be an awesome addition!

---

<div class="post-metadata">

**Author:** ![Mark\_Pederson](https://sea2.discourse-cdn.com/flex016/user_avatar/community.weweb.io/mark_pederson/32/14758_2.png) [@Mark\_Pederson](https://community.weweb.io/u/Mark_Pederson)\
**Post date:** [April 18, 2024, 12:29pm UTC](https://community.weweb.io/t/project-documentation/7864/5 "2024-04-18T12:29:31Z")

</div>

Love it - meantime - just giving us THIS will go a LONG way - [Please add DESCRIPTION field to variables (and workflows)](https://community.weweb.io/t/please-add-description-field-to-variables-and-workflows/5942)
