@redaksjon/protokoll 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.nvmrc +2 -0
- package/LICENSE +190 -0
- package/README.md +88 -0
- package/dist/arguments.js +158 -0
- package/dist/arguments.js.map +1 -0
- package/dist/constants.js +82 -0
- package/dist/constants.js.map +1 -0
- package/dist/logging.js +46 -0
- package/dist/logging.js.map +1 -0
- package/dist/main.js +5 -0
- package/dist/main.js.map +1 -0
- package/dist/phases/locate.js +55 -0
- package/dist/phases/locate.js.map +1 -0
- package/dist/phases/transcribe.js +149 -0
- package/dist/phases/transcribe.js.map +1 -0
- package/dist/processor.js +35 -0
- package/dist/processor.js.map +1 -0
- package/dist/prompt/instructions/transcribe.md +46 -0
- package/dist/prompt/personas/transcriber.md +37 -0
- package/dist/prompt/transcribe.js +41 -0
- package/dist/prompt/transcribe.js.map +1 -0
- package/dist/protokoll.js +81 -0
- package/dist/protokoll.js.map +1 -0
- package/dist/util/dates.js +96 -0
- package/dist/util/dates.js.map +1 -0
- package/dist/util/general.js +39 -0
- package/dist/util/general.js.map +1 -0
- package/dist/util/media.js +103 -0
- package/dist/util/media.js.map +1 -0
- package/dist/util/openai.js +92 -0
- package/dist/util/openai.js.map +1 -0
- package/dist/util/storage.js +135 -0
- package/dist/util/storage.js.map +1 -0
- package/docs/index.html +16 -0
- package/docs/package-lock.json +1521 -0
- package/docs/package.json +21 -0
- package/docs/vite.config.js +10 -0
- package/eslint.config.mjs +82 -0
- package/nodemon.json +14 -0
- package/output/kodrdriv/250702-1905-commit-message.md +1 -0
- package/output/kodrdriv/250702-1905-commit.request.json +14 -0
- package/output/kodrdriv/250702-1905-commit.response.json +36 -0
- package/output/kodrdriv/250702-1906-commit-message.md +1 -0
- package/output/kodrdriv/250702-1907-commit-message.md +1 -0
- package/output/kodrdriv/250702-1907-commit.request.json +14 -0
- package/output/kodrdriv/250702-1907-commit.response.json +36 -0
- package/output/kodrdriv/250716-1517-review-analysis.md +39 -0
- package/output/kodrdriv/250716-1517-review-notes.md +69 -0
- package/output/kodrdriv/250716-1518-review-analysis.md +15 -0
- package/output/kodrdriv/250716-1518-review-notes.md +67 -0
- package/output/kodrdriv/250716-1523-review-analysis.md +36 -0
- package/output/kodrdriv/250716-1523-review-notes.md +87 -0
- package/output/kodrdriv/250722-1135-commit-message.md +1 -0
- package/output/kodrdriv/250722-1331-commit-message.md +1 -0
- package/output/kodrdriv/250722-1335-commit-message.md +1 -0
- package/output/kodrdriv/250722-1337-commit-message.md +1 -0
- package/output/kodrdriv/250722-1342-release-notes.md +26 -0
- package/output/kodrdriv/250722-1416-commit-message.md +3 -0
- package/output/kodrdriv/250722-1420-commit-message.md +1 -0
- package/output/kodrdriv/250722-1422-commit-message.md +1 -0
- package/output/kodrdriv/250722-1423-commit-message.md +1 -0
- package/output/kodrdriv/250722-1425-release-notes.md +41 -0
- package/output/kodrdriv/250722-1527-commit-message.md +13 -0
- package/output/kodrdriv/250722-1532-commit-message.md +1 -0
- package/output/kodrdriv/250722-1532-release-notes.md +32 -0
- package/output/kodrdriv/250722-2314-review-analysis.md +28 -0
- package/output/kodrdriv/250722-2314-review-notes.md +464 -0
- package/output/kodrdriv/250722-2315-review-analysis.md +28 -0
- package/output/kodrdriv/250722-2315-review-notes.md +477 -0
- package/output/kodrdriv/250804-1623-review-analysis.md +38 -0
- package/output/kodrdriv/250804-1623-review-notes.md +479 -0
- package/output/kodrdriv/250804-1638-review-analysis.md +56 -0
- package/output/kodrdriv/250804-1638-review-notes.md +502 -0
- package/output/kodrdriv/250812-2021-review-analysis.md +27 -0
- package/output/kodrdriv/250812-2021-review-notes.md +571 -0
- package/output/kodrdriv/250826-0700-commit-message.md +12 -0
- package/output/kodrdriv/RELEASE_NOTES.md +30 -0
- package/output/kodrdriv/RELEASE_TITLE.md +1 -0
- package/package.json +78 -0
- package/tsconfig.tsbuildinfo +1 -0
- package/vite.config.ts +124 -0
- package/vitest.config.ts +30 -0
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
Removed local configuration and context files in favor of pnpm-workspace.yaml overrides; tightened dependency handling and updated instructional prompt
|
|
2
|
+
|
|
3
|
+
Deleted .cursorrules, .kodrdriv/config.yaml, and .kodrdriv/context/content.md to eliminate local test, workflow, and documentation rules. Added pnpm-workspace.yaml with explicit package link overrides to control dependency resolution. Expanded and clarified src/prompt/instructions/transcribe.md to set stricter constraints and formatting requirements for transcript processing, including clearer guidelines for spelling correction, Markdown structure, and fidelity, while discouraging summarization and interpretation. Refined src/arguments.ts and src/constants.ts to streamline config merging and remove unnecessary default properties and early argument parsing for --check-config and --init-config. Adjusted SecureConfigSchema in src/matnava.ts for proper secure configuration typing. Updated Vite rollupOptions externals list for more robust dependency exclusion. These changes enhance reproducibility, make project dependency management explicit, and improve transcript post-processing consistency.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
No changes detected — empty commit.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
No changes detected — empty commit.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
No changes detected — empty commit.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Dependency Upgrade, Workspace Cleanup, and Transcript Prompt Enhancement
|
|
2
|
+
|
|
3
|
+
In this release, the focus shifts towards streamlining dependency management, reducing local configuration overhead, and refining transcript formatting guidance to ensure accuracy, readability, and clarity. The intent—echoing the motif of clearing garden paths for new growth—is to make the project more reproducible and instructions for transcript post-processing more explicit, as guided by thoughtful constraint and curation.
|
|
4
|
+
|
|
5
|
+
**Improvements**
|
|
6
|
+
|
|
7
|
+
* **Dependencies Now Use Released Versions:**
|
|
8
|
+
* Upgraded `@riotprompt/riotprompt`, `@theunwalked/cardigantime`, and `@theunwalked/dreadcabinet` from local workspace links to published package versions in `package.json`.
|
|
9
|
+
* Updated the `packageManager` requirement to `pnpm 10.13.1`.
|
|
10
|
+
* Expanded Vite/rollup externals configuration for more robust build outputs.
|
|
11
|
+
|
|
12
|
+
* **Configuration and Workspace Simplification:**
|
|
13
|
+
* Removed `.kodrdriv/config.yaml`, `.kodrdriv/context/content.md`, `.cursorrules`, and `pnpm-workspace.yaml` to eliminate bespoke local configuration, manual dependency overrides, and context files no longer needed with published packages.
|
|
14
|
+
* Configuration handling in `src/arguments.ts` no longer gives precedence to isolated `--check-config` or `--init-config` flags; logic is streamlined for consistent config merging and validation.
|
|
15
|
+
* Redundant or unused default config properties removed from `src/constants.ts`.
|
|
16
|
+
* `SecureConfigSchema` in `src/matnava.ts` now has correct typing for improved type safety.
|
|
17
|
+
* Internal test and dev helper tips (e.g., about usage of `@ts-ignore` or mocking ESM modules in Jest) are no longer maintained as separate files.
|
|
18
|
+
|
|
19
|
+
* **Enhanced Transcript Post-Processing Prompt:**
|
|
20
|
+
* `src/prompt/instructions/transcribe.md` is rewritten for clarity: defines strictly what must be preserved, formatted, or corrected when processing Whisper transcripts.
|
|
21
|
+
* Clearer Markdown output structure, rules for paragraph and heading division, and a gentle but firm reminder not to summarise, interpret, or embellish transcripts.
|
|
22
|
+
* Adds constraints and concrete examples for spelling correction, entity resolution, and handling repetition—anchored in the value of preserving speaker intent and context fidelity.
|
|
23
|
+
* Outlines acceptable and unacceptable types of modification, improving downstream uses of the tool.
|
|
24
|
+
|
|
25
|
+
**Build and Test Workflow Updates**
|
|
26
|
+
|
|
27
|
+
* `mockdate` is removed from devDependencies as it is unused.
|
|
28
|
+
* Minor fixes to test assertions and type arrays in configuration files (e.g., `tsconfig.json` and tests/util/media.test.ts)
|
|
29
|
+
* Adjusted GitHub Actions (`pnpm-publish.yml`, `test.yml`) to run tests a single time before code coverage upload, preventing redundant executions.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
Like the careful pruning of a flowering bush, these changes clear away accumulated local constraints, update roots for stability, and nurture more reliable collaboration and clearer user-facing behaviour.
|
|
34
|
+
|
|
35
|
+
```text
|
|
36
|
+
"هر گل رعنا که در این بستان است
|
|
37
|
+
پیش اندیشهٔ ما خار کم از گل باشد"
|
|
38
|
+
|
|
39
|
+
"For every flourish in this garden, wisdom sees the nettle beneath the rose."
|
|
40
|
+
// This release cuts back the nettles of local overrides, opening space for shared understanding.
|
|
41
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
Add documentation site for Matnava with automated GitHub Pages deployment
|
|
2
|
+
|
|
3
|
+
Introduce a standalone documentation site under the `docs/` directory, built with React and Vite, featuring step-by-step setup instructions, feature overview, example usage, and customization guidance. The site leverages modern styling with dark/light mode support and is configured for GitHub Pages deployment.
|
|
4
|
+
|
|
5
|
+
Key additions and setup:
|
|
6
|
+
- `docs/README.md`: Instructions for local development, structure, and deployment workflow.
|
|
7
|
+
- `docs/src/`: Contains the main React components and styles (`App.jsx`, `index.css`, `main.jsx`).
|
|
8
|
+
- `docs/vite.config.js`: Vite configuration with `/matnava/` base for correct GH Pages routing.
|
|
9
|
+
- `docs/package.json`: Dependencies and scripts using pnpm.
|
|
10
|
+
- `.github/workflows/deploy-docs.yml`: GitHub Actions workflow to build and deploy the docs site on pushes to the `main` branch.
|
|
11
|
+
- `.gitignore`: Node, build artifacts, and local config files ignored under `docs/`.
|
|
12
|
+
|
|
13
|
+
This enables automated, seamless deployment of up-to-date documentation with every change to the `main` branch.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
No changes detected — empty commit.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Standalone Documentation Site with Automated GitHub Pages Deployment
|
|
2
|
+
|
|
3
|
+
This release centres on introducing a dedicated documentation site for Matnava, echoing a garden carefully cultivated for newcomers and long-time wanderers alike. The effort harmonises documentation, hosting, and dependency management: the "Release Focus" is to provide contributors and users with a reliable, self-contained, and always-current source of guidance, automatically deployed on every update to the main branch.
|
|
4
|
+
|
|
5
|
+
**New Features**
|
|
6
|
+
|
|
7
|
+
* Added a standalone React-based documentation site under the `docs/` directory.
|
|
8
|
+
* Documentation details quick start, key features, usage patterns, output formats, and customization guidance for Matnava.
|
|
9
|
+
* Modern design with dark/light mode support and a focus on clarity.
|
|
10
|
+
|
|
11
|
+
**Automated Deployment**
|
|
12
|
+
|
|
13
|
+
* Introduced `.github/workflows/deploy-docs.yml` GitHub Actions workflow to automate building and deploying the documentation site to GitHub Pages on pushes to the `main` branch.
|
|
14
|
+
* Deployment to `https://[username].github.io/matnava/` ensures the docs are always fresh and accessible, with each update reflected in production automatically.
|
|
15
|
+
|
|
16
|
+
**Dependency and Build Isolation**
|
|
17
|
+
|
|
18
|
+
* Added `docs/package-lock.json` to lock documentation site dependencies, ensuring reproducible installs and reliable CI builds.
|
|
19
|
+
* Introduced `docs/.npmrc` with `ignore-workspace=true` so that docs dependencies are not impacted by workspace or monorepo settings.
|
|
20
|
+
* Local development and CI are made more robust as docs/builds are decoupled from global or other workspace configurations.
|
|
21
|
+
|
|
22
|
+
**Project Structure**
|
|
23
|
+
|
|
24
|
+
* The documentation site's main content lives in `docs/src/`, with `App.jsx` (content), `index.css` (styling), and `main.jsx` (entry point).
|
|
25
|
+
* Vite is configured (`docs/vite.config.js`) for correct production routing under GitHub Pages.
|
|
26
|
+
* `.gitignore` within `docs/` keeps node modules, builds, dotfiles, and IDE settings out of version control.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
If I may borrow a phrase: "هر که در این سرا درآید، نانش دهید و از ایمانش مپرسید." ∎
|
|
31
|
+
|
|
32
|
+
> "Whoever enters this house, give them bread and do not ask of their faith." (Inscription at the tomb of Persian poet Saadi)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Review Analysis Result
|
|
2
|
+
|
|
3
|
+
## Summary
|
|
4
|
+
The review highlights the need for a systematic and intelligent approach to file management of audio transcripts, suggesting the introduction or use of dedicated directories (such as 'transcripts' and 'notes') to streamline processing and prevent redundant reprocessing. The current workflow causes confusion and inefficiency due to transcripts being repeatedly sent to the same processing engines, as there is no file organization indicating completed or in-progress items.
|
|
5
|
+
|
|
6
|
+
## Total Issues Found
|
|
7
|
+
1
|
|
8
|
+
|
|
9
|
+
## Issues
|
|
10
|
+
|
|
11
|
+
[
|
|
12
|
+
{
|
|
13
|
+
"title": "Introduce dedicated directories for transcript file lifecycle management",
|
|
14
|
+
"description": "Currently, all transcript files are collected without a clear organizational system, leading to duplicate processing and reduced workflow efficiency. The reviewer suggests implementing a system where transcripts, once generated by the transcription tool (e.g., Matnava), are placed in a dedicated 'transcripts' directory. After they are processed (e.g., reviewed or converted into notes), they should be moved to a secondary directory such as 'notes' or 'review'. This will make it easier to track which files need further attention and which have already been processed, reducing the risk of unnecessary duplicate work.",
|
|
15
|
+
"priority": "medium",
|
|
16
|
+
"category": "functionality",
|
|
17
|
+
"suggestions": [
|
|
18
|
+
"Update the transcript generation tool to save all new transcripts in a top-level 'transcripts' directory.",
|
|
19
|
+
"Implement logic or a script to move transcripts from 'transcripts' to a 'notes' or 'review' directory once they have been processed.",
|
|
20
|
+
"Update documentation and workflow instructions to clarify the new file handling process for transcripts and notes.",
|
|
21
|
+
"Consider adopting a naming or tagging system to further clarify the processing status of each file if directories alone are not sufficient."
|
|
22
|
+
]
|
|
23
|
+
}
|
|
24
|
+
]
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
*Analysis completed at 2025-07-23T06:14:55.213Z*
|
|
@@ -0,0 +1,464 @@
|
|
|
1
|
+
# Review Notes
|
|
2
|
+
|
|
3
|
+
I do think that we need to have a more intelligent way of handling transcripts. Once you make a transcript, I think you should also put it in a `transcripts` directory. The reason why I think you should do that is because if you create a transcript, it usually has to be understood, processed, and put somewhere else.
|
|
4
|
+
|
|
5
|
+
You could direct it to multiple places, but one example here is what I just did. I looked at all the sound files, all the transcripts, and I checked them all out. For most of the PL1s, I passed them to the review engine, and the review engine understood them. I would like to put them in another directory called `review` or `notes.` Maybe it goes into a `transcripts` directory, and then it goes into a `notes` directory once it's done.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
I think that would be very useful because when you transcribe a bunch of texts, you're transcribing it usually for a purpose. That purpose often requires you to pay attention to it. What I found myself doing because everything is just going to output for notes is I'm sending the same files to the same processes over and over again. This is because I'm not smart enough to realize like, oh, I already processed that. I don't need to process that again. That's already been done.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
The transcript taker, whatever that project is called—I think it's like Mazama or something, Makalava, Matsnava—that thing needs to drop the files in a transcription directory. That's it. That's really it.
|
|
12
|
+
|
|
13
|
+
# Commit History Context
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
[Recent Commit History]
|
|
18
|
+
commit 2af48dccaf2d88b04eeba60a88a7cc0ac61822cb
|
|
19
|
+
Author: Simran Jafari <jafarisimran@gmail.com>
|
|
20
|
+
Date: Tue Jul 22 15:33:53 2025 -0700
|
|
21
|
+
|
|
22
|
+
0.0.4
|
|
23
|
+
|
|
24
|
+
(#3)
|
|
25
|
+
|
|
26
|
+
* Add documentation site for Matnava with automated GitHub Pages deployment
|
|
27
|
+
|
|
28
|
+
Introduce a standalone documentation site under the `docs/` directory, built with React and Vite, featuring step-by-step setup instructions, feature overview, example usage, and customization guidance. The site leverages modern styling with dark/light mode support and is configured for GitHub Pages deployment.
|
|
29
|
+
|
|
30
|
+
Key additions and setup:
|
|
31
|
+
- `docs/README.md`: Instructions for local development, structure, and deployment workflow.
|
|
32
|
+
- `docs/src/`: Contains the main React components and styles (`App.jsx`, `index.css`, `main.jsx`).
|
|
33
|
+
- `docs/vite.config.js`: Vite configuration with `/matnava/` base for correct GH Pages routing.
|
|
34
|
+
- `docs/package.json`: Dependencies and scripts using pnpm.
|
|
35
|
+
- `.github/workflows/deploy-docs.yml`: GitHub Actions workflow to build and deploy the docs site on pushes to the `main` branch.
|
|
36
|
+
- `.gitignore`: Node, build artifacts, and local config files ignored under `docs/`.
|
|
37
|
+
|
|
38
|
+
This enables automated, seamless deployment of up-to-date documentation with every change to the `main` branch.
|
|
39
|
+
|
|
40
|
+
* Add NPM lockfile and .npmrc to docs for isolated dependency management
|
|
41
|
+
|
|
42
|
+
Introduced `docs/package-lock.json` to lock dependency versions for the documentation site, ensuring reproducible installs regardless of workspace settings. Added `docs/.npmrc` with `ignore-workspace=true` to prevent local or monorepo workspace dependencies from interfering, supporting reliable standalone installation via npm. These files improve CI stability and local development by decoupling the docs build from any global or workspace package manager configuration.
|
|
43
|
+
|
|
44
|
+
* No changes detected — empty commit.
|
|
45
|
+
|
|
46
|
+
* 0.0.4
|
|
47
|
+
|
|
48
|
+
commit 6c8c60dbf41bd6c24de187fa217b4835fcb1dfa5
|
|
49
|
+
Author: Simran Jafari <jafarisimran@gmail.com>
|
|
50
|
+
Date: Tue Jul 22 14:27:02 2025 -0700
|
|
51
|
+
|
|
52
|
+
0.0.3
|
|
53
|
+
|
|
54
|
+
(#2)
|
|
55
|
+
|
|
56
|
+
* Removed ts-expect-error for config shape in matnava.ts, corrected error assertion in media utility test to throw an error, and fixed typo in tsconfig.json types array by removing duplicate entries and ensuring correct type specification.
|
|
57
|
+
|
|
58
|
+
* Upgraded @riotprompt/riotprompt, @theunwalked/cardigantime, and @theunwalked/dreadcabinet dependencies from local workspace links to released package versions in package.json, removed pnpm-workspace.yaml, and updated the packageManager field to require pnpm 10.13.1. This streamlines dependency management by transitioning from local development references to stable, published versions, and eliminates the need for custom workspace overrides.
|
|
59
|
+
|
|
60
|
+
* Removed mockdate from devDependencies in package.json to eliminate unused development dependency.
|
|
61
|
+
|
|
62
|
+
* Removed duplicate test execution in GitHub Actions workflows by deleting redundant 'pnpm test --coverage' steps from both pnpm-publish.yml and test.yml, ensuring tests run only once before code coverage upload.
|
|
63
|
+
|
|
64
|
+
* 0.0.2
|
|
65
|
+
|
|
66
|
+
* Removed local configuration and context files in favor of pnpm-workspace.yaml overrides; tightened dependency handling and updated instructional prompt
|
|
67
|
+
|
|
68
|
+
Deleted .cursorrules, .kodrdriv/config.yaml, and .kodrdriv/context/content.md to eliminate local test, workflow, and documentation rules. Added pnpm-workspace.yaml with explicit package link overrides to control dependency resolution. Expanded and clarified src/prompt/instructions/transcribe.md to set stricter constraints and formatting requirements for transcript processing, including clearer guidelines for spelling correction, Markdown structure, and fidelity, while discouraging summarization and interpretation. Refined src/arguments.ts and src/constants.ts to streamline config merging and remove unnecessary default properties and early argument parsing for --check-config and --init-config. Adjusted SecureConfigSchema in src/matnava.ts for proper secure configuration typing. Updated Vite rollupOptions externals list for more robust dependency exclusion. These changes enhance reproducibility, make project dependency management explicit, and improve transcript post-processing consistency.
|
|
69
|
+
|
|
70
|
+
* No changes detected — empty commit.
|
|
71
|
+
|
|
72
|
+
* No changes detected — empty commit.
|
|
73
|
+
|
|
74
|
+
* No changes detected — empty commit.
|
|
75
|
+
|
|
76
|
+
* Removing pnpm-workspace
|
|
77
|
+
|
|
78
|
+
* 0.0.3
|
|
79
|
+
|
|
80
|
+
commit de67713d5aa8b4e2fcdf7d3a4b5cfc0ff0e26dca
|
|
81
|
+
Author: Simran Jafari <jafarisimran@gmail.com>
|
|
82
|
+
Date: Tue Jul 22 11:16:09 2025 -0700
|
|
83
|
+
|
|
84
|
+
Initial commit
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
# Recent Diffs Context
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
[Recent Diff 1 (HEAD~1)]
|
|
92
|
+
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
|
|
93
|
+
new file mode 100644
|
|
94
|
+
index 0000000..a9fd775
|
|
95
|
+
--- /dev/null
|
|
96
|
+
+++ b/.github/workflows/deploy-docs.yml
|
|
97
|
+
@@ -0,0 +1,61 @@
|
|
98
|
+
+name: Deploy Documentation to GitHub Pages
|
|
99
|
+
+
|
|
100
|
+
+on:
|
|
101
|
+
+ push:
|
|
102
|
+
+ branches: [ main ]
|
|
103
|
+
+ workflow_dispatch:
|
|
104
|
+
+
|
|
105
|
+
+permissions:
|
|
106
|
+
+ contents: read
|
|
107
|
+
+ pages: write
|
|
108
|
+
+ id-token: write
|
|
109
|
+
+
|
|
110
|
+
+concurrency:
|
|
111
|
+
+ group: "pages"
|
|
112
|
+
+ cancel-in-progress: false
|
|
113
|
+
+
|
|
114
|
+
+jobs:
|
|
115
|
+
+ build:
|
|
116
|
+
+ runs-on: ubuntu-latest
|
|
117
|
+
+ steps:
|
|
118
|
+
+ - name: Checkout
|
|
119
|
+
+ uses: actions/checkout@v4
|
|
120
|
+
+
|
|
121
|
+
+ - name: Setup Node.js
|
|
122
|
+
+ uses: actions/setup-node@v4
|
|
123
|
+
+ with:
|
|
124
|
+
+ node-version: '18'
|
|
125
|
+
+
|
|
126
|
+
+ - name: Setup pnpm
|
|
127
|
+
+ uses: pnpm/action-setup@v4
|
|
128
|
+
+ with:
|
|
129
|
+
+ version: 10.13.1
|
|
130
|
+
+
|
|
131
|
+
+ - name: Install dependencies
|
|
132
|
+
+ run: |
|
|
133
|
+
+ cd docs
|
|
134
|
+
+ pnpm install
|
|
135
|
+
+
|
|
136
|
+
+ - name: Build documentation
|
|
137
|
+
+ run: |
|
|
138
|
+
+ cd docs
|
|
139
|
+
+ pnpm run build
|
|
140
|
+
+
|
|
141
|
+
+ - name: Setup Pages
|
|
142
|
+
+ uses: actions/configure-pages@v4
|
|
143
|
+
+
|
|
144
|
+
+ - name: Upload artifact
|
|
145
|
+
+ uses: actions/upload-pages-artifact@v3
|
|
146
|
+
+ with:
|
|
147
|
+
+ path: ./docs/dist
|
|
148
|
+
+
|
|
149
|
+
+ deploy:
|
|
150
|
+
+ environment:
|
|
151
|
+
+ name: github-pages
|
|
152
|
+
+ url: ${{ steps.deployment.outputs.page_url }}
|
|
153
|
+
+ runs-on: ubuntu-latest
|
|
154
|
+
+ needs: build
|
|
155
|
+
+ steps:
|
|
156
|
+
+ - name: Deploy to GitHub Pages
|
|
157
|
+
+ id: deployment
|
|
158
|
+
+ uses: actions/deploy-pages@v4
|
|
159
|
+
|
|
160
|
+
diff --git a/docs/.gitignore b/docs/.gitignore
|
|
161
|
+
new file mode 100644
|
|
162
|
+
index 0000000..3c4acb8
|
|
163
|
+
--- /dev/null
|
|
164
|
+
+++ b/docs/.gitignore
|
|
165
|
+
@@ -0,0 +1,38 @@
|
|
166
|
+
+# Dependencies
|
|
167
|
+
+node_modules/
|
|
168
|
+
+/.pnp
|
|
169
|
+
+.pnp.js
|
|
170
|
+
+
|
|
171
|
+
+# Production builds
|
|
172
|
+
+/dist
|
|
173
|
+
+/build
|
|
174
|
+
+
|
|
175
|
+
+# Environment variables
|
|
176
|
+
+.env
|
|
177
|
+
+.env.local
|
|
178
|
+
+.env.development.local
|
|
179
|
+
+.env.test.local
|
|
180
|
+
+.env.production.local
|
|
181
|
+
+
|
|
182
|
+
+# Logs
|
|
183
|
+
+npm-debug.log*
|
|
184
|
+
+yarn-debug.log*
|
|
185
|
+
+yarn-error.log*
|
|
186
|
+
+pnpm-debug.log*
|
|
187
|
+
+lerna-debug.log*
|
|
188
|
+
+
|
|
189
|
+
+# Runtime data
|
|
190
|
+
+pids
|
|
191
|
+
+*.pid
|
|
192
|
+
+*.seed
|
|
193
|
+
+*.pid.lock
|
|
194
|
+
+
|
|
195
|
+
+# IDE files
|
|
196
|
+
+.vscode/
|
|
197
|
+
+.idea/
|
|
198
|
+
+*.swp
|
|
199
|
+
+*.swo
|
|
200
|
+
+
|
|
201
|
+
+# OS files
|
|
202
|
+
+.DS_Store
|
|
203
|
+
+Thumbs.db
|
|
204
|
+
|
|
205
|
+
diff --git a/docs/.npmrc b/docs/.npmrc
|
|
206
|
+
new file mode 100644
|
|
207
|
+
index 0000000..de14fd9
|
|
208
|
+
--- /dev/null
|
|
209
|
+
+++ b/docs/.npmrc
|
|
210
|
+
@@ -0,0 +1 @@
|
|
211
|
+
+ignore-workspace=true
|
|
212
|
+
diff --git a/docs/README.md b/docs/README.md
|
|
213
|
+
new file mode 100644
|
|
214
|
+
index 0000000..fe32a9d
|
|
215
|
+
--- /dev/null
|
|
216
|
+
+++ b/docs/README.md
|
|
217
|
+
@@ -0,0 +1,50 @@
|
|
218
|
+
+# Matnava Documentation Site
|
|
219
|
+
+
|
|
220
|
+
+This is a simple React documentation site for Matnava, deployed automatically to GitHub Pages.
|
|
221
|
+
+
|
|
222
|
+
+## Local Development
|
|
223
|
+
+
|
|
224
|
+
+To work on the documentation site locally:
|
|
225
|
+
+
|
|
226
|
+
+```bash
|
|
227
|
+
+# Navigate to the docs directory
|
|
228
|
+
+cd docs
|
|
229
|
+
+
|
|
230
|
+
+# Install dependencies
|
|
231
|
+
+pnpm install
|
|
232
|
+
+
|
|
233
|
+
+# Start the development server
|
|
234
|
+
+pnpm run dev
|
|
235
|
+
+
|
|
236
|
+
+# Build for production
|
|
237
|
+
+pnpm run build
|
|
238
|
+
+
|
|
239
|
+
+# Preview the production build
|
|
240
|
+
+pnpm run preview
|
|
241
|
+
+```
|
|
242
|
+
+
|
|
243
|
+
+## Deployment
|
|
244
|
+
+
|
|
245
|
+
+The site is automatically deployed to GitHub Pages via a GitHub workflow whenever commits are pushed to the `main` branch. The workflow:
|
|
246
|
+
+
|
|
247
|
+
+1. Installs dependencies using pnpm
|
|
248
|
+
+2. Builds the React app
|
|
249
|
+
+3. Deploys to GitHub Pages
|
|
250
|
+
+
|
|
251
|
+
+The site will be available at: `https://[username].github.io/matnava/`
|
|
252
|
+
+
|
|
253
|
+
+## Structure
|
|
254
|
+
+
|
|
255
|
+
+- `src/App.jsx` - Main React component with all the documentation content
|
|
256
|
+
+- `src/index.css` - Styles with dark/light mode support
|
|
257
|
+
+- `vite.config.js` - Vite configuration with GitHub Pages base path
|
|
258
|
+
+- `package.json` - Dependencies and scripts for the React app
|
|
259
|
+
+
|
|
260
|
+
+## Customization
|
|
261
|
+
+
|
|
262
|
+
+To update the documentation:
|
|
263
|
+
+
|
|
264
|
+
+1. Edit `src/App.jsx` to modify content
|
|
265
|
+
+2. Edit `src/index.css` to modify styling
|
|
266
|
+
+3. Test locally with `pnpm run dev`
|
|
267
|
+
+4. Commit and push to trigger automatic deployment
|
|
268
|
+
|
|
269
|
+
diff --git a/docs/index.html b/docs/index.html
|
|
270
|
+
new file mode 100644
|
|
271
|
+
index 0000000..cb07c28
|
|
272
|
+
--- /dev/null
|
|
273
|
+
+++ b/docs/index.html
|
|
274
|
+
@@ -0,0 +1,16 @@
|
|
275
|
+
+<!doctype html>
|
|
276
|
+
+<html lang="en">
|
|
277
|
+
+
|
|
278
|
+
+<head>
|
|
279
|
+
+ <meta charset="UTF-8" />
|
|
280
|
+
+ <link rel="icon" type="image/svg+xml" href="/vite.svg" />
|
|
281
|
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
282
|
+
+ <title>Matnava - Focused Audio Transcription Tool</title>
|
|
283
|
+
+</head>
|
|
284
|
+
+
|
|
285
|
+
+<body>
|
|
286
|
+
+ <div id="root"></div>
|
|
287
|
+
+ <script type="module" src="/src/main.jsx"></script>
|
|
288
|
+
+</body>
|
|
289
|
+
+
|
|
290
|
+
+</html>
|
|
291
|
+
|
|
292
|
+
diff --git a/docs/package.json b/docs/package.json
|
|
293
|
+
new file mode 100644
|
|
294
|
+
index 0000000..e338989
|
|
295
|
+
--- /dev/null
|
|
296
|
+
+++ b/docs/package.json
|
|
297
|
+
@@ -0,0 +1,21 @@
|
|
298
|
+
+{
|
|
299
|
+
+ "name": "matnava-docs",
|
|
300
|
+
+ "version": "1.0.0",
|
|
301
|
+
+ "description": "Documentation site for Matnava - a focused transcription tool",
|
|
302
|
+
+ "type": "module",
|
|
303
|
+
+ "scripts": {
|
|
304
|
+
+ "dev": "vite",
|
|
305
|
+
+ "build": "vite build",
|
|
306
|
+
+ "preview": "vite preview"
|
|
307
|
+
+ },
|
|
308
|
+
+ "dependencies": {
|
|
309
|
+
+ "react": "^18.2.0",
|
|
310
|
+
+ "react-dom": "^18.2.0"
|
|
311
|
+
+ },
|
|
312
|
+
+ "devDependencies": {
|
|
313
|
+
+ "@types/react": "^18.2.0",
|
|
314
|
+
+ "@types/react-dom": "^18.2.0",
|
|
315
|
+
+ "@vitejs/plugin-react": "^4.0.0",
|
|
316
|
+
+ "vite": "^5.0.0"
|
|
317
|
+
+ }
|
|
318
|
+
+}
|
|
319
|
+
|
|
320
|
+
... [TRUNCATED: Original diff was 16153 characters, showing first 4987] ...
|
|
321
|
+
|
|
322
|
+
[Recent Diff 2 (HEAD~2..HEAD~1)]
|
|
323
|
+
diff --git a/.cursorrules b/.cursorrules
|
|
324
|
+
deleted file mode 100644
|
|
325
|
+
index ac40cec..0000000
|
|
326
|
+
--- a/.cursorrules
|
|
327
|
+
+++ /dev/null
|
|
328
|
+
@@ -1,8 +0,0 @@
|
|
329
|
+
-When writing tests make use of @ts-ignore to simplify things. Don't spend too much effort trying to address these errors.
|
|
330
|
+
-
|
|
331
|
+
-When mocking ESM modules in Jest, we need to make use of this approach:
|
|
332
|
+
-
|
|
333
|
+
- // Mock the modules before importing
|
|
334
|
+
- jest.unstable_mockModule('../../src/logging', () => ({
|
|
335
|
+
- getLogger: jest.fn(() => mockLogger)
|
|
336
|
+
- }));
|
|
337
|
+
diff --git a/.github/workflows/pnpm-publish.yml b/.github/workflows/pnpm-publish.yml
|
|
338
|
+
index cadaebc..18e8c81 100644
|
|
339
|
+
--- a/.github/workflows/pnpm-publish.yml
|
|
340
|
+
+++ b/.github/workflows/pnpm-publish.yml
|
|
341
|
+
@@ -24,7 +24,7 @@ jobs:
|
|
342
|
+
- run: pnpm install --frozen-lockfile --strict-peer-dependencies
|
|
343
|
+
- run: pnpm run lint
|
|
344
|
+
- run: pnpm run build
|
|
345
|
+
- - run: pnpm test --coverage
|
|
346
|
+
+ - run: pnpm test
|
|
347
|
+
- uses: codecov/codecov-action@v5
|
|
348
|
+
with:
|
|
349
|
+
slug: jafarisimran/maloomscan
|
|
350
|
+
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
|
|
351
|
+
index 894747f..31e6581 100644
|
|
352
|
+
--- a/.github/workflows/test.yml
|
|
353
|
+
+++ b/.github/workflows/test.yml
|
|
354
|
+
@@ -22,7 +22,7 @@ jobs:
|
|
355
|
+
- run: pnpm install --frozen-lockfile --strict-peer-dependencies
|
|
356
|
+
- run: pnpm run lint
|
|
357
|
+
- run: pnpm run build
|
|
358
|
+
- - run: pnpm test --coverage
|
|
359
|
+
+ - run: pnpm test
|
|
360
|
+
- uses: codecov/codecov-action@v5
|
|
361
|
+
with:
|
|
362
|
+
slug: jafarisimran/maloomscan
|
|
363
|
+
diff --git a/.kodrdriv/config.yaml b/.kodrdriv/config.yaml
|
|
364
|
+
deleted file mode 100644
|
|
365
|
+
index 6e93ef3..0000000
|
|
366
|
+
--- a/.kodrdriv/config.yaml
|
|
367
|
+
+++ /dev/null
|
|
368
|
+
@@ -1,8 +0,0 @@
|
|
369
|
+
-contextDirectories:
|
|
370
|
+
- - .kodrdriv/context
|
|
371
|
+
-commit:
|
|
372
|
+
- cached: true
|
|
373
|
+
- sendit: true
|
|
374
|
+
-release:
|
|
375
|
+
- from: main
|
|
376
|
+
- to: HEAD
|
|
377
|
+
|
|
378
|
+
diff --git a/.kodrdriv/context/content.md b/.kodrdriv/context/content.md
|
|
379
|
+
deleted file mode 100644
|
|
380
|
+
index 28ae833..0000000
|
|
381
|
+
--- a/.kodrdriv/context/content.md
|
|
382
|
+
+++ /dev/null
|
|
383
|
+
@@ -1 +0,0 @@
|
|
384
|
+
-Maloomscan takes audio recordings and turned them into intellgent notes.
|
|
385
|
+
diff --git a/package.json b/package.json
|
|
386
|
+
index 3785f24..e544d4d 100644
|
|
387
|
+
--- a/package.json
|
|
388
|
+
+++ b/package.json
|
|
389
|
+
@@ -1,6 +1,6 @@
|
|
390
|
+
{
|
|
391
|
+
"name": "@jankhoj/matnava",
|
|
392
|
+
- "version": "0.0.1",
|
|
393
|
+
+ "version": "0.0.3",
|
|
394
|
+
"description": "Matnava is a focused transcription tool that helps you transcribe audio intelligently using context.",
|
|
395
|
+
"main": "dist/main.js",
|
|
396
|
+
"type": "module",
|
|
397
|
+
@@ -11,7 +11,7 @@
|
|
398
|
+
"type": "git",
|
|
399
|
+
"url": "git+https://github.com/jafarisimran/matnava.git"
|
|
400
|
+
},
|
|
401
|
+
- "packageManager": "pnpm@10.11.0",
|
|
402
|
+
+ "packageManager": "pnpm@10.13.1",
|
|
403
|
+
"scripts": {
|
|
404
|
+
"build": "pnpm run lint &&tsc --noEmit && vite build && copyfiles -u 1 \"src/**/*.md\" dist",
|
|
405
|
+
"dev": "vite",
|
|
406
|
+
@@ -31,9 +31,9 @@
|
|
407
|
+
"author": "Simran Jafari <jafarisimran@gmail.com>",
|
|
408
|
+
"license": "Apache-2.0",
|
|
409
|
+
"dependencies": {
|
|
410
|
+
- "@riotprompt/riotprompt": "link:../../StJustReckoning/riotprompt",
|
|
411
|
+
- "@theunwalked/cardigantime": "link:../../SemicolonAmbulance/cardigantime",
|
|
412
|
+
- "@theunwalked/dreadcabinet": "link:../../SemicolonAmbulance/dreadcabinet",
|
|
413
|
+
+ "@riotprompt/riotprompt": "^0.0.8",
|
|
414
|
+
+ "@theunwalked/cardigantime": "^0.0.16",
|
|
415
|
+
+ "@theunwalked/dreadcabinet": "^0.0.10",
|
|
416
|
+
"@types/fluent-ffmpeg": "^2.1.27",
|
|
417
|
+
"commander": "^14.0.0",
|
|
418
|
+
"dayjs": "^1.11.13",
|
|
419
|
+
@@ -62,6 +62,7 @@
|
|
420
|
+
"eslint": "^9.31.0",
|
|
421
|
+
"eslint-plugin-import": "^2.32.0",
|
|
422
|
+
"globals": "^16.3.0",
|
|
423
|
+
+ "mockdate": "^3.0.5",
|
|
424
|
+
"rollup-plugin-preserve-shebang": "^1.0.1",
|
|
425
|
+
"rollup-plugin-visualizer": "^6.0.3",
|
|
426
|
+
"typescript": "^5.8.3",
|
|
427
|
+
@@ -69,4 +70,4 @@
|
|
428
|
+
"vite-plugin-node": "^7.0.0",
|
|
429
|
+
"vitest": "^3.2.4"
|
|
430
|
+
}
|
|
431
|
+
-}
|
|
432
|
+
|
|
433
|
+
+}
|
|
434
|
+
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
|
|
435
|
+
deleted file mode 100644
|
|
436
|
+
index 39693c1..0000000
|
|
437
|
+
--- a/pnpm-workspace.yaml
|
|
438
|
+
+++ /dev/null
|
|
439
|
+
@@ -1,4 +0,0 @@
|
|
440
|
+
-overrides:
|
|
441
|
+
- '@riotprompt/riotprompt': link:../../StJustReckoning/riotprompt
|
|
442
|
+
- '@theunwalked/cardigantime': link:../../SemicolonAmbulance/cardigantime
|
|
443
|
+
- '@theunwalked/dreadcabinet': link:../../SemicolonAmbulance/dreadcabinet
|
|
444
|
+
diff --git a/src/arguments.ts b/src/arguments.ts
|
|
445
|
+
index 00dc70e..1e435ff 100644
|
|
446
|
+
--- a/src/arguments.ts
|
|
447
|
+
+++ b/src/arguments.ts
|
|
448
|
+
@@ -36,23 +36,50 @@ export const configure = async (dreadcabinet: Dreadcabinet.DreadCabinet, cardiga
|
|
449
|
+
program = await cardigantime.configure(program);
|
|
450
|
+
program.version(VERSION);
|
|
451
|
+
|
|
452
|
+
+ // Check if --check-config is in process.argv early
|
|
453
|
+
+ if (process.argv.includes('--check-config')) {
|
|
454
|
+
+ program.parse();
|
|
455
|
+
+ const cliArgs: Args = program.opts<Args>();
|
|
456
|
+
+
|
|
457
|
+
+ // Use CardiganTime's built-in checkConfig method
|
|
458
|
+
+ await cardigantime.checkConfig(cliArgs);
|
|
459
|
+
+
|
|
460
|
+
+ // Return minimal config for consistency, but main processing is done
|
|
461
|
+
+ const config: Config = MATNAVA_DEFAULTS as Config;
|
|
462
|
+
|
|
463
|
+
... [TRUNCATED: Original diff was 13636 characters, showing first 4951] ...
|
|
464
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Review Analysis Result
|
|
2
|
+
|
|
3
|
+
## Summary
|
|
4
|
+
The review highlights potential improvements for the transcription tool and concepts around project analytics (referred to as MindShone). The main actionable issue is to introduce a unified dashboard aggregating statistics and insights across projects, building on ideas from the reviewer's previous MindShone project. No duplicates are found with current open issues.
|
|
5
|
+
|
|
6
|
+
## Total Issues Found
|
|
7
|
+
1
|
|
8
|
+
|
|
9
|
+
## Issues
|
|
10
|
+
|
|
11
|
+
[
|
|
12
|
+
{
|
|
13
|
+
"title": "Implement a Unified Project Analytics Dashboard (MindShone Concept)",
|
|
14
|
+
"description": "The reviewer suggests adding a 'unified view', similar to RunGhost or inspired by the original MindShone concept. This dashboard should aggregate and report on statistics across all monitored projects—such as the number of audio files, count and location of transcripts, and general progress metrics. The reviewer wants insights on overall progress, involvement levels per project, and comparative attention over time. The value is to provide high-level navigation and situational awareness, not just individual file stats.",
|
|
15
|
+
"priority": "medium",
|
|
16
|
+
"category": "functionality",
|
|
17
|
+
"suggestions": [
|
|
18
|
+
"Design and implement a dashboard that aggregates statistics (e.g., counts of audio files, transcripts, project-wise activity) across all configured projects.",
|
|
19
|
+
"Provide features to compare engagement or work distribution between projects over user-defined time frames.",
|
|
20
|
+
"Consider supporting navigation links from aggregated stats to specific transcripts or audio files.",
|
|
21
|
+
"Ensure configurability so the dashboard can be adapted if project or user requirements evolve (e.g., toggling which stats are shown, custom timeframes)."
|
|
22
|
+
]
|
|
23
|
+
}
|
|
24
|
+
]
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
*Analysis completed at 2025-07-23T06:15:38.137Z*
|