Skip to content

Commit 07254ea

Browse files
committed
Add readme guidelines for contribution documentation
1 parent cfd2f1a commit 07254ea

2 files changed

Lines changed: 26 additions & 1 deletion

File tree

_mydocs/contribute/doc-sites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ menu_title: Documentation Sites
55
published: true
66
date: 2025-10-28
77
modified: 2025-10-28
8-
order: /06
8+
order: /07
99
next_reading: true
1010
---
1111

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: page
3+
title: Readme guidelines
4+
menu_title: Readme guidelines
5+
published: true
6+
date: 2025-12-31
7+
modified: 2025-12-31
8+
order: /06
9+
next_reading: true
10+
---
11+
12+
The `README.md` file with your library will be displayed alongside your library on [daxlib.org](https://daxlib.org/). Its content must follow these guidelines to ensure consistency and to be approved for publication.
13+
14+
- **External links** are permitted only if they are safe and trustworthy. All links will be verified using Google Safe Browsing (https://transparencyreport.google.com/safe-browsing/search).
15+
- **Do not** include images that **imitate**, replicate, or closely resemble **UI elements** from the DAX Lib website.
16+
- **Do not embed images** or assets as Base64. **Use standard URLs** to reference all media assets.
17+
- Image **aspect ratio must be preserved**. Prefer specifying only the `width` attribute so the height scales automatically.
18+
- **Large images** should be **optimized** to maintain reasonable performance.
19+
- **Do not wrap images in links**. Images must not be clickable or redirect users.
20+
- **Avoid inline CSS or styling** that overrides global styles (if applicable to your system).
21+
- **Do not embed iframe** objects.
22+
23+
You can include in the `README.md` file a link to a sample file to showcase how to use the functions in your library.
24+
25+
If you need a more comprehensive documentation site, consider creating a dedicated documentation website as described in the [Documentation sites](doc-sites.md) section.

0 commit comments

Comments
 (0)