Skip to content

Commit 4ec2b3e

Browse files
PriveeteePriveetee
committed
feat(core): set up initial project scaffold
1 parent a9f2815 commit 4ec2b3e

14 files changed

Lines changed: 879 additions & 0 deletions

File tree

‎.editorconfig‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# EditorConfig helps developers define and maintain consistent
2+
# coding styles between different editors and IDEs
3+
# editorconfig.org
4+
5+
root = true
6+
7+
[*]
8+
end_of_line = lf
9+
charset = utf-8
10+
trim_trailing_whitespace = true
11+
insert_final_newline = true
12+
indent_style = space
13+
indent_size = 4
14+
15+
[*.rs]
16+
max_line_length = 100
17+
18+
[*.md]
19+
# double whitespace at end of line
20+
# denotes a line break in Markdown
21+
trim_trailing_whitespace = false
22+
23+
[*.yml]
24+
indent_size = 2
25+
26+
[Makefile]
27+
indent_style = tab

‎.github/dependabot.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for more information:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
# https://containers.dev/guide/dependabot
6+
7+
version: 2
8+
updates:
9+
- package-ecosystem: "devcontainers"
10+
directory: "/"
11+
schedule:
12+
interval: weekly
13+
- package-ecosystem: "github-actions"
14+
directory: "/"
15+
schedule:
16+
interval: weekly

‎.github/workflows/typos.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Spelling
2+
3+
permissions:
4+
contents: read
5+
6+
on:
7+
push:
8+
pull_request:
9+
workflow_dispatch:
10+
11+
env:
12+
CLICOLOR: 1
13+
14+
jobs:
15+
spelling:
16+
name: Spell Check with Typos
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Checkout Actions Repository
20+
uses: actions/checkout@v5
21+
- name: Spell Check Repo
22+
uses: crate-ci/typos@v1.35.3

‎.gitignore‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# VitePress generated files
5+
/docs/.vitepress/cache
6+
/docs/.vitepress/dist
7+
8+
# Build output
9+
/dist
10+
11+
# System files
12+
.DS_Store
13+
Thumbs.db
14+
15+
# Log files
16+
npm-debug.log*
17+
yarn-debug.log*
18+
yarn-error.log*
19+
bun-debug.log*
20+
21+
# Editor directories and files
22+
.idea
23+
.vscode
24+
*.suo
25+
*.ntvs*
26+
*.njsproj
27+
*.sln
28+
*.sw?

‎.typos.toml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[files]
2+
extend-exclude = [
3+
"docs/nl/",
4+
"docs/.vitepress/nl.ts",
5+
"docs/pt/",
6+
"docs/.vitepress/pt.ts",
7+
"docs/zh_cn/",
8+
"docs/.vitepress/zh_cn.ts",
9+
]

‎CODE_OF_CONDUCT.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards and
42+
will take appropriate and fair corrective action in response to any behavior
43+
that they deem inappropriate, threatening, offensive, or harmful.
44+
45+
Community leaders have the right and responsibility to remove, edit, or reject
46+
comments, commits, code, wiki edits, issues, and other contributions that are
47+
not aligned to this Code of Conduct, and will communicate reasons for moderation
48+
decisions when appropriate.
49+
50+
## Scope
51+
52+
This Code of Conduct applies within all community spaces, and also applies when
53+
an individual is officially representing the community in public spaces.
54+
Examples of representing our community include using an official e-mail address,
55+
posting via an official social media account, or acting as an appointed
56+
representative at an online or offline event.
57+
58+
## Enforcement
59+
60+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
61+
reported to the community leaders responsible for enforcement at
62+
[pipepipedocs.fedora245@passmail.net].
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interaction in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
119+
120+
[homepage]: https://www.contributor-covenant.org
121+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

‎CONTRIBUTING.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to the PipePipe Wiki
2+
3+
Thank you for your interest in contributing! Your help is essential for keeping this guide accurate and up-to-date.
4+
5+
## How to Contribute
6+
7+
The easiest way to contribute is by adding or editing the documentation pages. All content is written in Markdown.
8+
9+
### Submitting Changes
10+
11+
1. **Fork the repository** on GitHub.
12+
2. **Create a new branch** for your changes: `git checkout -b feat/add-new-feature-doc`.
13+
3. **Make your changes** to the relevant `.md` files inside the `docs/` directory.
14+
4. **Commit your changes** with a clear and descriptive message. We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
15+
```sh
16+
git commit -m "docs: update guide for audio focus feature"
17+
```
18+
5. **Push your branch** to your fork: `git push origin feat/add-new-feature-doc`.
19+
6. **Open a Pull Request** from your fork to the main repository.
20+
21+
### Reporting Issues
22+
23+
If you find a typo, outdated information, or have an idea for a new page but don't want to write it yourself, please [open an issue](https://github.com/YOUR-USERNAME/YOUR-REPO/issues) on GitHub.
24+
25+
## Code of Conduct
26+
27+
All contributors are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).

‎README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# PipePipe Wiki
2+
3+
The unofficial, user-driven guide for the PipePipe application. This project aims to provide comprehensive documentation for both new and experienced users.
4+
5+
This website is built with [VitePress](https://vitepress.dev/).
6+
7+
## Development
8+
9+
1. Clone the repository:
10+
```sh
11+
git clone https://github.com/Priveetee/Docs-PipePipe.git
12+
cd Docs-PipePipe
13+
```
14+
2. Install dependencies:
15+
```sh
16+
bun install
17+
```
18+
3. Run the local development server:
19+
```sh
20+
bun run dev
21+
```
22+
23+
The site will be available at `http://localhost:5173`.
24+
25+
## Contributing
26+
27+
Contributions are welcome. Please read the [Contributing Guide](CONTRIBUTING.md) for details on how to submit changes.

0 commit comments

Comments
 (0)