Skip to content

Commit

Permalink
Add prettier and linter workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
tupui committed Aug 4, 2024
1 parent 7fbb763 commit d1c84c3
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 6 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,26 @@ jobs:
with:
python-version: "3.12"
- uses: pre-commit/[email protected]

website:
runs-on: ubuntu-latest

steps:
- name: Checkout App Repo
uses: actions/checkout@v4

- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: "20"
cache: "yarn"
cache-dependency-path: "**/yarn.lock"

- name: Install App Dependencies
run: cd website && yarn --prefer-offline

- name: Check MDX
run: yarn check:mdx

- name: Build app
run: yarn build
3 changes: 1 addition & 2 deletions website/docs/developers/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,10 @@ We also need to think about the most reluctant maintainers and have ways to obse

The first version of the dApp will be simple and focus on a basic feature set. We first need to build trust with the community and only then we can expand our feature set with what our users actually need.

The dApp will leverage well-known JS SDKs to propose an effective and familiar user interface. We will start with stellar-sdk, sorobandomains-sdk and soroban-astro-template. This will help us build faster and handle addresses and signing safely so that our system never sees a user's secret key–hence fully non-custodial. On that note, having a list of maintainers allows a project to have “social backups” in the sense that another maintainer can help recover access.
The dApp will leverage well-known JS SDKs to propose an effective and familiar user interface. We will start with stellar-sdk, sorobandomains-sdk and soroban-astro-template. This will help us build faster and handle addresses and signing safely so that our system never sees a user's secret key–hence fully non-custodial. On that note, having a list of maintainers allows a project to have “social backups” in the sense that another maintainer can help recover access.

Maintainers will be able to handle all aspects of their projects on the dApp. They will have tools to add or remove maintainers, update metadata and set the new commit hash of the project.

Users will be able to view project details and observe its current state. We will link each commit hash to the centralization platform the project is using. The metadata file, similar to a SEP-1, will be rendered to show useful information to users.

In general, the interface should be clear enough to show where the data is coming from and there should be a simple way to see the data on-chain and off-chain.

4 changes: 2 additions & 2 deletions website/docs/developers/dapps_and_contracts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
sidebar_position: 2
---

import CodeBlock from '@theme/CodeBlock';
import contrac_id from '!!raw-loader!../../../.soroban/soroban_versioning_id';
import CodeBlock from "@theme/CodeBlock";
import contrac_id from "!!raw-loader!../../../.soroban/soroban_versioning_id";

# dApps and Contracts

Expand Down
2 changes: 1 addition & 1 deletion website/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ sidebar_position: 1
---

# Welcome to Tansu!

Tansu adds an extra layer of security when developing Open Source projects. In essence, it proposes a solution to track code changes and enable anyone to verify that the code hosted on GitHub is indeed the same. Coupled with other best practices, such as, code signing and attestation of provenance, Tansu guarantees that the code history has not been tempered with.
17 changes: 17 additions & 0 deletions website/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"typecheck": "tsc"
"typecheck": "tsc",
"format:mdx": "prettier --write \"{docs,src/pages}/**/*.{md,mdx}\"",
"check:mdx": "prettier -c \"{docs,src/pages}/**/*.{md,mdx}\""
},
"dependencies": {
"@docusaurus/core": "3.4.0",
Expand All @@ -28,6 +30,7 @@
"@docusaurus/module-type-aliases": "3.4.0",
"@docusaurus/tsconfig": "3.4.0",
"@docusaurus/types": "3.4.0",
"prettier": "^3.3.3",
"typescript": "~5.2.2"
},
"browserslist": {
Expand Down

0 comments on commit d1c84c3

Please sign in to comment.