Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,9 @@ repos:
language: system
types: [rust]
pass_filenames: false
- id: biome
name: biome
entry: bash -c 'cd docs && npx biome ci src/ docusaurus.config.ts sidebars.ts'
language: system
files: ^docs/src/|^docs/docusaurus\.config\.ts|^docs/sidebars\.ts
pass_filenames: false
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@

**A fast, Rust-backed DAG engine for Python.**

[![CI](https://github.com/ByteVeda/dagron/actions/workflows/ci.yml/badge.svg)](https://github.com/ByteVeda/dagron/actions/workflows/ci.yml)
[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-3776ab?logo=python&logoColor=white)](https://python.org)
[![Built with Rust](https://img.shields.io/badge/built%20with-Rust-dea584?logo=rust&logoColor=white)](https://www.rust-lang.org)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![v0.1.0](https://img.shields.io/badge/version-0.1.0-blue)](https://pypi.org/project/dagron/)
[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://byteveda.github.io/dagron/)

Build, execute, and analyze directed acyclic graphs with a fluent Python API — powered by Rust and [petgraph](https://github.com/petgraph/petgraph) under the hood.

Expand Down
55 changes: 55 additions & 0 deletions docs/biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"$schema": "https://biomejs.dev/schemas/2.4.9/schema.json",
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
},
"files": {
"ignoreUnknown": true,
"includes": ["src/**", "docusaurus.config.ts", "sidebars.ts"]
},
"formatter": {
"enabled": true,
"indentStyle": "space",
"indentWidth": 2
},
"linter": {
"enabled": true,
"rules": {
"recommended": true,
"correctness": {
"noUnusedImports": "warn"
},
"suspicious": {
"noExplicitAny": "off",
"noArrayIndexKey": "off"
},
"a11y": {
"useButtonType": "warn",
"noStaticElementInteractions": "off",
"noLabelWithoutControl": "off"
},
"complexity": {
"noImportantStyles": "off"
},
"style": {
"noNonNullAssertion": "off"
}
}
},
"javascript": {
"formatter": {
"quoteStyle": "single",
"trailingCommas": "all"
}
},
"assist": {
"enabled": true,
"actions": {
"source": {
"organizeImports": "on"
}
}
}
}
50 changes: 30 additions & 20 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import type {Plugin} from '@docusaurus/types';
import type { Config, Plugin } from '@docusaurus/types';
import { themes as prismThemes } from 'prism-react-renderer';

const config: Config = {
title: 'dagron',
tagline: 'High-performance DAG execution engine for Python, powered by Rust',
favicon: 'img/favicon.ico',

url: 'https://dagron.dev',
baseUrl: '/',
url: 'https://byteveda.github.io',
baseUrl: '/dagron/',

organizationName: 'dagron',
organizationName: 'ByteVeda',
projectName: 'dagron',

onBrokenLinks: 'throw',
Expand All @@ -36,9 +35,7 @@ const config: Config = {
name: 'ignore-vscode-languageserver-warning',
configureWebpack() {
return {
ignoreWarnings: [
{module: /vscode-languageserver-types/},
],
ignoreWarnings: [{ module: /vscode-languageserver-types/ }],
};
},
};
Expand Down Expand Up @@ -80,17 +77,17 @@ const config: Config = {
label: 'API Reference',
},
{
href: 'https://github.com/pratyush618/dagron/blob/master/CHANGELOG.md',
href: 'https://github.com/ByteVeda/dagron/blob/master/CHANGELOG.md',
label: 'Changelog',
position: 'right',
},
{
href: 'https://github.com/pratyush618/dagron/blob/master/CONTRIBUTING.md',
href: 'https://github.com/ByteVeda/dagron/blob/master/CONTRIBUTING.md',
label: 'Contributing',
position: 'right',
},
{
href: 'https://github.com/dagron/dagron',
href: 'https://github.com/ByteVeda/dagron',
label: 'GitHub',
position: 'right',
},
Expand All @@ -102,17 +99,23 @@ const config: Config = {
{
title: 'Documentation',
items: [
{label: 'Guide', to: '/guide/getting-started'},
{label: 'API Reference', to: '/api/core/core'},
{ label: 'Guide', to: '/guide/getting-started' },
{ label: 'API Reference', to: '/api/core/core' },
],
},
{
title: 'More',
items: [
{label: 'GitHub', href: 'https://github.com/dagron/dagron'},
{label: 'PyPI', href: 'https://pypi.org/project/dagron/'},
{label: 'Changelog', href: 'https://github.com/pratyush618/dagron/blob/master/CHANGELOG.md'},
{label: 'Contributing', href: 'https://github.com/pratyush618/dagron/blob/master/CONTRIBUTING.md'},
{ label: 'GitHub', href: 'https://github.com/ByteVeda/dagron' },
{ label: 'PyPI', href: 'https://pypi.org/project/dagron/' },
{
label: 'Changelog',
href: 'https://github.com/ByteVeda/dagron/blob/master/CHANGELOG.md',
},
{
label: 'Contributing',
href: 'https://github.com/ByteVeda/dagron/blob/master/CONTRIBUTING.md',
},
],
},
],
Expand All @@ -121,10 +124,17 @@ const config: Config = {
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
additionalLanguages: ['python', 'rust', 'typescript', 'bash', 'json', 'toml'],
additionalLanguages: [
'python',
'rust',
'typescript',
'bash',
'json',
'toml',
],
},
mermaid: {
theme: {light: 'default', dark: 'dark'},
theme: { light: 'default', dark: 'dark' },
options: {},
},
colorMode: {
Expand Down
164 changes: 164 additions & 0 deletions docs/package-lock.json

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

4 changes: 3 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"typecheck": "tsc"
"typecheck": "tsc",
"check": "biome ci src/ docusaurus.config.ts sidebars.ts"
},
"dependencies": {
"@docusaurus/core": "^3.9.2",
Expand All @@ -25,6 +26,7 @@
"react-dom": "^19.0.0"
},
"devDependencies": {
"@biomejs/biome": "2.4.10",
"@docusaurus/module-type-aliases": "^3.9.2",
"@docusaurus/tsconfig": "^3.9.2",
"@docusaurus/types": "^3.9.2",
Expand Down
Loading
Loading