ci: run Markdown linter

.github/workflows/markdown_lint.yml

@@ -0,0 +1,28 @@
+name: Markdown Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    # Also trigger on ready_for_review to run when a PR changes from draft to ready
+    types: [opened, reopened, synchronize, ready_for_review]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name != 'pull_request' || !github.event.pull_request.draft }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install rumdl pre-compiled binary
+        run: |
+          # Define the URL for the latest Linux binary
+          DOWNLOAD_URL="https://github.com/rvben/rumdl/releases/download/v0.0.185/rumdl-v0.0.185-x86_64-unknown-linux-gnu.tar.gz"
+
+          # Use curl to download the archive and tar to extract it
+          curl -sL $DOWNLOAD_URL | tar -xz -C /usr/local/bin/
+
+          # Ensure the binary is executable and in the PATH
+          chmod +x /usr/local/bin/rumdl
+      - name: Lint Markdown
+        run: rumdl check --output-format github .

.rumdl.toml

@@ -0,0 +1,75 @@
+# rumdl configuration file
+
+# Global configuration options
+[global]
+# List of rules to disable (uncomment and modify as needed)
+# disable = ["MD013", "MD033"]
+
+# List of rules to enable exclusively (if provided, only these rules will run)
+# enable = ["MD001", "MD003", "MD004"]
+
+# List of file/directory patterns to include for linting (if provided, only these will be linted)
+# include = [
+#    "docs/*.md",
+#    "src/**/*.md",
+#    "README.md"
+# ]
+
+# List of file/directory patterns to exclude from linting
+exclude = [
+    # Common directories to exclude
+    ".git",
+    # ".github",
+    "node_modules",
+    "vendor",
+    "dist",
+    "build",
+
+    # Specific files or patterns
+    # "CHANGELOG.md",
+    # "LICENSE.md",
+]
+
+# Respect .gitignore files when scanning directories (default: true)
+respect-gitignore = true
+
+# Markdown flavor/dialect (uncomment to enable)
+# Options: mkdocs, gfm, commonmark
+# flavor = "mkdocs"
+
+# Rule-specific configurations (uncomment and modify as needed)
+
+# [MD003]
+# style = "atx"  # Heading style (atx, atx_closed, setext)
+
+# [MD004]
+# style = "asterisk"  # Unordered list style (asterisk, plus, dash, consistent)
+
+# [MD007]
+# indent = 4  # Unordered list indentation
+
+[MD013]
+line-length = 80  # Line length
+code-blocks = false  # Exclude code blocks from line length check
+tables = false  # Exclude tables from line length check
+headings = true  # Include headings in line length check
+reflow = true  # Enable automatic line wrapping (required for --fix)
+reflow-mode = "normalize"  # Reflow mode: "default", "normalize", or "sentence-per-line" (default: "default")
+
+
+
+# [MD044]
+# names = ["rumdl", "Markdown", "GitHub"]  # Proper names that should be capitalized correctly
+# code-blocks = false  # Check code blocks for proper names (default: false, skips code blocks)
+
+[MD029]
+# Style options:
+# - "one" or "one-one": All items numbered "1." (easiest maintenance)
+# - "ordered": Sequential numbering (1, 2, 3...)
+# - "ordered0": Zero-based sequential (0, 1, 2...)
+# - "one-or-ordered": Auto-detect per list (either all-ones OR sequential)
+# - "consistent": Document-wide consistency - uses most common style across all lists
+style = "one"  # Default - matches markdownlint behavior
+
+[MD033]
+allowed-elements = ["details", "summary"] # List of allowed HTML tags (default: none)

README.md

@@ -1,19 +1,23 @@
 # Developer Guidelines
 
-Welcome to our Developer Guidelines!
-Your journey to shape the future starts here.
+Welcome to our Developer Guidelines! Your journey to shape the future of DeFi
+starts here.
 
 ## For Developers
 
-_Developers_ are everyone creating value—business developers, designers, engineers, marketers, and beyond. We build businesses, products, partnerships, customer relationships, processes, and delivery methods, crafting the future we envision.
+_Developers_ are everyone creating value—business developers, designers,
+engineers, marketers, and beyond. We build businesses, products, partnerships,
+customer relationships, processes, and delivery methods, crafting the future we
+envision.
 
 Align with:
 
-- [Principles](./.github/PRINCIPLES.md)
-- [Contributing Guidelines](./.github/CONTRIBUTING.md)
-- [Advocacy Guidelines](./.github/ADVOCACY.md)
-- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
-- [Sick Leave Policy](./.github/LEAVE_POLICY.md)
-- [Compensation Guide](./.github/COMPENSATION.md)
+- [Principles](./docs/PRINCIPLES.md)
+- [Contributing Guidelines](./docs/CONTRIBUTING.md)
+- [Advocacy Guidelines](./docs/ADVOCACY.md)
+- [Code of Conduct](./docs/CODE_OF_CONDUCT.md)
+- [Leave Policy](./docs/LEAVE_POLICY.md)
+- [Compensation Guide](./docs/COMPENSATION.md)
 
-Subscribe to repository notifications to stay updated with frequent fixes and improvements.
+Subscribe to repository notifications to stay updated with frequent fixes and
+improvements.

.github/ADVOCACY.md → docs/ADVOCACY.md

@@ -1,17 +1,21 @@
 # Advocacy Guidelines
 
-If you are a Holdex team member, we expect you to advocate for Holdex,
-its mission, and its values. This includes:
+If you are a Holdex team member, we expect you to advocate for Holdex, its
+mission, and its values. This includes:
 
-- Participate in community events and activities that align with Holdex's mission and values.
-- Share Holdex-related content on social media platforms, including LinkedIn and Twitter.
-- Represent Holdex professionally and ethically, and to uphold the company's code of conduct at all times.
+- Participate in community events and activities that align with Holdex's
+  mission and values.
+- Share Holdex-related content on social media platforms, including LinkedIn and
+  Twitter.
+- Represent Holdex professionally and ethically, and to uphold the company's
+  code of conduct at all times.
 
 ## Social Media Presence
 
 Your Personal Social Media Presence:
 
-- Create and maintain a professional LinkedIn profile that showcases your work at Holdex.
+- Create and maintain a professional LinkedIn profile that showcases your work
+  at Holdex.
 - Use Twitter to share Holdex-related news, updates, and insights.
 - Engage with Holdex's community on social media platforms, responding to
 comments and questions.
@@ -23,8 +27,8 @@ Twitter) profiles to reflect Holdex.
 
 ### GitHub Bio
 
-You must exclusively promote Holdex during the period you being under Holdex contract, you should not include any mentions of other brands or any links other than Holdex-related links.
-
+While employed by Holdex, exclusively promote Holdex in your bio. Do not include
+other brands or non-Holdex links..
 
 | Github Profile Attributes | Acceptance Criteria                                                                                                                                                                                                                                   |
 |---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -38,12 +42,12 @@ You must exclusively promote Holdex during the period you being under Holdex con
 | Social link 2 – Website   | <https://holdex.io/c/jobs>                                                                                                                                                                                                                              |
 | Social link 3 – LinkedIn  | <https://linkedin.com/company/holdexlimited>                                                                                                                                                                                                            |
 | Pinned Repositories       | Trial                                                                                                                                                                                                                                                 |
-| Overview (not urgent)     | Guidelines<br>Create a ‘README.md’ file in public self-repo that states:<ul><li>Role at Holdex</li><li>What you do & what you love about Holdex</li><li>Link to Holdex website</li></ul>                                                                       |
-
+| Overview     | Create a ‘README.md’ file in public self-repo that states: role at Holdex, what you do & what you love about Holdex, link to Holdex website and GitHub organization profile.                                                                                      |
 
 ### LinkedIn Profile
 
-Must mention Holdex in the ‘Experiences’ tab & place it as the recent / current role.
+Must mention Holdex in the ‘Experiences’ tab & place it as the recent / current
+role.
 
 Mandatory `Experience` description:
 > Holdex is premier partner for institutions pioneering DeFi & RWAs. Hong Kong-based since 2016, we turn bold visions into secure, scalable blockchain solutions – driving adoption with unmatched expertise.
@@ -52,4 +56,4 @@ Mandatory `Experience` description:
 
 - Must mention your role @HoldexIo within the profile description.
 - Link to Holdex website / portfolio.
-- Location: localhost
+- Location: localhost