Skip to content

Commit aca0d1e

Browse files
committed
Updated CONTRIBUTING.md with accurate info and fixed GH Actions URLs to point to new repo home
1 parent b7c1301 commit aca0d1e

3 files changed

Lines changed: 10 additions & 9 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
steps:
1414
- uses: actions/checkout@v4
1515
- name: Clone Curriculum
16-
run: git clone https://github.com/razorblade23/the-python-ledger.git ../the-python-ledger
16+
run: git clone https://github.com/ThePythonLedger/Curriculum.git ../Curriculum
1717
- name: Install and Build
1818
run: |
1919
npm install

CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,23 @@ First off, thank you for considering contributing! Projects like this live and b
88

99
### 1. Content Contributor (Education)
1010
Help us build the curriculum! We need writers who can explain complex Python concepts in a beginner-friendly way.
11-
* **Target:** [The Python Ledger](https://github.com/razorblade23/the-python-ledger).
12-
* **Format:** Markdown files using our custom `<InteractivePython>` component (You do not need to know React, its rendered automaticly for you if using `interactive` tag on a code block.
11+
* **Target:** [The Python Ledger](https://github.com/ThePythonLedger/Curriculum).
12+
* **Format:** Markdown files using our custom `<InteractivePython>` component for rendering engine to provide runnable python instance (You do not need to know React, its rendered automaticly for you if using `interactive` tag on a code block.
1313
* **Goal:** Create hands-on projects (like the Text Adventure) that reinforce the ledger theme or expand and fix lessons.
1414

1515
### 2. Engine Contributor (Development)
1616
Help us polish the interactive experience.
17-
* **Target:** `/src/components/InteractivePython/`.
18-
* **Tech:** React, Skulpt.js, CodeMirror.
19-
* **Focus:** Improving terminal UI, handling edge cases in Python execution, or adding support for Python standard libraries.
17+
* **Target:** `*`.
18+
* **Tech:** React, CodeMirror.
19+
* **Focus:** Improving UI, adding features.
2020

2121
---
2222

2323
## 🚀 How to Get Started
2424

25-
1. **Find an Issue:** Check the [GitHub Issues](https://github.com/razorblade23/the-python-ledger-engine/issues) for tags like `good first issue` or `help wanted`.
25+
1. **Find an Issue:** Check the [GitHub Issues](https://github.com/ThePythonLedger/Docusaurus-engine/issues) for tags like `good first issue` or `help wanted`.
2626
2. **Fork & Clone:** Fork the repo and clone it locally.
27+
3. **Clone Curriculum**: You will need Curriculum to successfily build the engine
2728
3. **Install Dependencies:**
2829
```bash
2930
npm install

docusaurus.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ const config = {
4646
/** @type {import('@docusaurus/preset-classic').Options} */
4747
({
4848
docs: {
49-
path: '../the-python-ledger/curriculum',
49+
path: '../Curriculum/curriculum',
5050
routeBasePath: '/lessons',
5151
sidebarPath: require.resolve('./sidebars.js'),
5252
editUrl: ({ docPath }) => {
@@ -79,7 +79,7 @@ const config = {
7979
'@docusaurus/plugin-content-docs',
8080
{
8181
id: 'introduction', // Unique identifier for this instance
82-
path: '../the-python-ledger/introduction', // Path to your second MD folder
82+
path: '../Curriculum/introduction', // Path to your second MD folder
8383
routeBasePath: '/introduction', // Base URL (e.g., /introduction/hello-world)
8484
sidebarPath: require.resolve('./sidebarsIntroduction.js'),
8585
// You can also add a unique editUrl here if needed

0 commit comments

Comments
 (0)