Skip to content

Commit 083a78c

Browse files
authored
Add README section to contributing doc (#49)
1 parent 6fb44e3 commit 083a78c

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

contributing.qmd

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,17 @@ It is recommended to begin with `"version": "0.0.0"` to avoid triggering a
5858
release during development of your content. When you are ready to release to
5959
the gallery check the [Adding content to the Connect Gallery](#adding-content-to-the-connect-gallery) section.
6060

61+
### README.md
62+
63+
In the above extension section there is a `homepage` link that we provide in the
64+
Connect Gallery letting users see documentation related to the apps, dashboards,
65+
and reports available to install.
66+
67+
Gallery content should include a `README.md` file in its directory so when the
68+
homepage is visited there is documentation to assist users. It should include
69+
a description of how the content can be used and any additional setup
70+
instructions.
71+
6172
### Language version constraints
6273

6374
To ensure that content in the gallery is installable on as many Posit Connect

0 commit comments

Comments
 (0)