Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

prepare for monorepo #9

Merged
merged 40 commits into from
Dec 19, 2024
Merged
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
01182d1
chore: package format updates
inverted-capital Oct 24, 2024
f2219d2
refactor: split artifact into napps
inverted-capital Oct 27, 2024
d91e141
fmt
inverted-capital Oct 27, 2024
e8b18a5
feat(execution): action creators read in napp.jsonc
inverted-capital Oct 28, 2024
3ba3908
refactor: break apart global types into package domains
inverted-capital Oct 30, 2024
f5100c5
feat: trail replaces accumulator
inverted-capital Nov 1, 2024
4a1dc4d
feat: export napp.json from all packages
inverted-capital Nov 1, 2024
4a26605
napp example config
inverted-capital Nov 2, 2024
70a49ff
refactor: remove kvoauth from server
inverted-capital Nov 4, 2024
e179f87
refactor: explode out engine components
inverted-capital Nov 4, 2024
3e3255a
feat(api): NappApi interface defined
inverted-capital Nov 7, 2024
cbebeb5
refactor(api): refine napp-api interface names
inverted-capital Nov 10, 2024
869933e
feat(execution): Trail runs an actual napp function
inverted-capital Nov 12, 2024
1c11c5e
fix(execution): trail test passes
inverted-capital Nov 12, 2024
a6a22e9
feat(execution): add file payloads to trail
inverted-capital Nov 15, 2024
243a333
refactor: move openai to jsr version
inverted-capital Nov 15, 2024
6c65aec
refactor(execution): move files resolver out
inverted-capital Nov 18, 2024
2f7cc0c
feat(shockwave): sketch out interface and update README.md
inverted-capital Nov 18, 2024
b376328
refactor: allow undefined on jsonvalue types
inverted-capital Nov 18, 2024
5d1fbb5
refactor: rename eval-file-runner to evals
inverted-capital Nov 18, 2024
269e8d7
refactor(api): convert interfaces to readonly
inverted-capital Nov 21, 2024
f915da2
feat(git-kv): add design reasoning
inverted-capital Dec 9, 2024
e712f66
bring in concat and pdfs napps
inverted-capital Dec 12, 2024
00577df
feat(crawl): ability to crawl pages in an LLM friendly way
inverted-capital Dec 13, 2024
cf54a1a
feat(chat): add chat extraction tool and YouTube audio downloader
inverted-capital Dec 15, 2024
788fdc5
chore(deno): add version field to deno.json
inverted-capital Dec 15, 2024
b732685
fix(chat): update main function signature to return a Promise<void>
inverted-capital Dec 15, 2024
bd95b47
chore(chat): update CLI permissions and version, refactor output path…
inverted-capital Dec 15, 2024
bbfdf2d
chore(chat): update import path for @std/path to use versioned module
inverted-capital Dec 15, 2024
623291e
feat(napp-tools): enhance nappSchema and add NAPP format specification
inverted-capital Dec 16, 2024
daf7bfe
add net access to chatgpt.com
inverted-capital Dec 16, 2024
226843b
make cli be main export
inverted-capital Dec 16, 2024
e850dd9
chore(chat): bump version to 0.0.6 and update conversation output format
inverted-capital Dec 16, 2024
599fe11
instructions
inverted-capital Dec 16, 2024
a0f07fd
wordy project map instructions
inverted-capital Dec 16, 2024
beedb46
compacted project map instructions
inverted-capital Dec 16, 2024
2e1f53a
add math spec for chat module
inverted-capital Dec 17, 2024
8a48cc3
update to render in github
inverted-capital Dec 17, 2024
aaa7c3a
add partial end compartment for dynamic code
inverted-capital Dec 18, 2024
eefad39
seed the stucks napp
inverted-capital Dec 19, 2024
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
Prev Previous commit
Next Next commit
wordy project map instructions
  • Loading branch information
inverted-capital committed Dec 16, 2024
commit a0f07fd5e26db714bddb8091086d70cb96e402a5
70 changes: 43 additions & 27 deletions reasoner/PROJECT_MAP_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,47 @@
# PROJECT_MAP_INSTRUCTIONS

**Motivation:**\
A well-structured overview file named `PROJECT_MAP.md` provides a top-level,
maintainable map of your project—whether it's a codebase or a knowledge base. It
highlights the purpose of key components, how they connect, and why they exist,
without getting lost in the details. This high-level perspective makes
onboarding easier, streamlines maintenance, and ensures everyone stays aligned
on the overall structure.
A well-structured overview file named `PROJECT_MAP.md` **must** provide a
top-level, maintainable map of your project—whether it's a codebase or a
knowledge base. It **must** highlight the purpose of key components, how they
connect, and why they exist, without getting lost in the details. This
high-level perspective **must** make onboarding easier, streamline maintenance,
and ensure everyone stays aligned on the overall structure.

**How to Create One:**
**How to Create a PROJECT_MAP.md file:**

1. **Establish the Hierarchy:**
- Begin at the project’s **root** (e.g., `📦 PROJECT_ROOT/`).
- Organize by **folders**, **files**, and **dependent subprojects**, placing
the most important items nearer the top.
- You **must** begin at the project’s **root** (e.g., `📦 PROJECT_ROOT/`).
- You **must** organize by **folders**, **files**, placing the most important
items nearer the top.
- **dependent projects** and **code package dependencies** must be listed
under a dedicated `dependencies` directory at the bottom of the hierarchy,
with the `vendor-docs` above it, if present.

2. **Notation and Sections:**
- Represent **projects** with `📦`, **directories** with `📂`, and **files**
with `📄`.
- Represent **projects** with `📦`, **directories** with `📂`, **files** with
`📄`, and **dependent projects** (non-package dependencies) with `🧩`.
- Under each file, use numbered bullets (`1.`, `2.`, etc.) for individual
**sections**, **functions**, or **tests**.
- Each item (file, function, or test) should have a **rationale note** (`ℹ`)
beneath it, explaining its purpose or relevance.
- For **code files**: Only list exported functions. Place a rationale note
under each function.
- For **test files**: List each test as a bullet, with a rationale note
explaining which function it tests and why.
- For **knowledge files**: List main topics or sections, each with a
rationale note.
- Each item (file, function, or test) **should** have a **rationale note**
(`ℹ`) beneath it, explaining its purpose or relevance.
- For **code files**: You **must** only list exported functions. You
**should** place a rationale note under each function.
- For **test files**: You **must** list each test as a bullet, with a
rationale note explaining which function it tests and why.
- For **knowledge files**: You **must** list top level topics or sections,
each with a rationale note.

3. **High-Level Focus and Omissions:**
- Do **not** include `PROJECT_MAP.md` itself in the diagram—it’s a
meta-document, not part of the structure.
- Omit minor internal files that serve only private, non-architectural roles
to keep the map concise.
- Include **dependencies** or **subprojects** by listing them as `📦` entries
under a dedicated `dependencies` directory. This shows where nested
structures fit in the architecture.
- You **must** omit minor internal files that serve only private,
non-architectural roles to keep the map concise.
- Include **dependencies** and **subprojects** by listing them under a
dedicated `dependencies` directory.
- If there is a `vendor-docs` directory, list only the folders in this
directory, and use the rationale doc to state which dependency the
documentation is for.

4. **Clarity Over Detail:**
- The goal is to provide a meaningful overview. Avoid overly detailed
Expand Down Expand Up @@ -134,7 +139,18 @@ on the overall structure.
│ 3. Usage
│ ℹ Explains how to run and interact with the project

├─ 📂 vendor-docs
│ │ ℹ Documentation here relates specifically to dependencies (both code packages and dependent projects)
│ └─ 📄 commander/README.md
│ ℹ Documentation for the `commander` library used by the CLI to parse command-line arguments

└─ 📂 dependencies
├─ 📦 subproject1
└─ 📦 subproject2
├─ 📦 @babel/parser
│ ℹ Used to parse and evaluate embedded JSON data structures in script tags
├─ 📦 @my-org/some-package
│ ℹ A scoped npm package providing specialized parsing utilities
├─ 🧩 subproject1
│ ℹ A dependent project integrated as part of the tool’s ecosystem
└─ 📦 commander
ℹ Command-line argument parsing library for the CLI interface
```