Skip to content

Commit d7b5659

Browse files
jeffdyerclaude
andcommitted
Add usage-guide.md to build-spec script for public access
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1443b72 commit d7b5659

2 files changed

Lines changed: 74 additions & 1 deletion

File tree

packages/api/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"coverage": "nyc npm run test",
1212
"lint": "eslint src/ tools/",
1313
"lint:fix": "eslint src/ tools/ --fix",
14-
"build-spec": "npx spec-md ./spec/spec.md > ./public/spec.html && cp ./spec/template.gc ./public && cp ./spec/instructions.md ./public",
14+
"build-spec": "npx spec-md ./spec/spec.md > ./public/spec.html && cp ./spec/template.gc ./public && cp ./spec/instructions.md ./public && cp ./spec/usage-guide.md ./public",
1515
"watch-spec": "npx nodemon --exec 'npx spec-md > ./public/spec.html' ./spec/spec.md"
1616
},
1717
"dependencies": {

packages/api/spec/usage-guide.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
2+
3+
# L0166 Usage Guide
4+
5+
Welcome to the L0166 language guide, where you'll learn how to create and customize spreadsheets using natural language requests. This language is accessible through the Graffiticode MCP tool and console, allowing both AI agents and human users to generate structured spreadsheet documents with ease.
6+
7+
## What You Can Create with L0166
8+
9+
### Basic Spreadsheet Structures
10+
11+
L0166 allows you to create spreadsheets with various structural elements:
12+
13+
- **Single Cells and Grids**: You can create spreadsheets with a single empty cell or a grid of any size. For example, "Create a spreadsheet with a single empty cell" or "Make a 2 by 2 empty grid."
14+
- **Titled Spreadsheets**: Add titles to your spreadsheets for clarity. For instance, "Create a spreadsheet with the title 'Monthly Report' and an empty grid."
15+
- **Headers and Lists**: Design spreadsheets with headers and lists. Requests like "Create a spreadsheet with two columns. Column A header is 'Item' and column B header is 'Price'. Make both headers bold" are supported.
16+
17+
### Column Configuration
18+
19+
Customize the appearance and behavior of columns:
20+
21+
- **Width and Alignment**: Specify column widths and alignments. For example, "Make a spreadsheet with one column that is 200 pixels wide" or "Create a spreadsheet with a column B that is right-aligned for displaying dollar amounts."
22+
- **Styling**: Apply styles such as bold, italic, or background colors to columns. Requests like "Make a spreadsheet with column A styled in italic" are possible.
23+
24+
### Cell Text and Content
25+
26+
Populate cells with various types of content:
27+
28+
- **Text and Numbers**: Enter text or numeric values into cells. For instance, "Create a spreadsheet with three cells in column A containing the numbers 10, 20, and 30."
29+
- **Formulas**: Use simple formulas like SUM and AVERAGE. For example, "Create a spreadsheet with values 10, 20, 30, 40, 50 in cells A1 through A5, and put a SUM formula in A6 that totals them."
30+
31+
### Cell and Row Formatting
32+
33+
Enhance the visual presentation of your spreadsheets:
34+
35+
- **Cell Formatting**: Apply styles such as bold, italic, underline, or background colors to individual cells. For example, "Make a cell with red text that says 'Warning'."
36+
- **Row Formatting**: Format entire rows with styles like bold text or background colors. Requests like "Create a spreadsheet where row 1 is bold" are supported.
37+
38+
### Assessment and Validation
39+
40+
Incorporate assessment features to validate user input:
41+
42+
- **Input Validation**: Create cells that expect specific inputs and validate them. For example, "Create a cell where the student must enter the value 100. Validate their answer."
43+
- **Assessed Formulas**: Use formulas in assessed cells to check for correct calculations. For instance, "Put values 10, 20, and 30 in A1 through A3. Assess cell A4 expecting the student to enter the formula =SUM(A1:A3)."
44+
45+
### Parameterized Templates
46+
47+
Use parameters to create dynamic spreadsheets:
48+
49+
- **Parameterized Cells**: Populate cells with values provided through parameters. For example, "Create a spreadsheet with a parameter that populates cell A1 with 'Hello'."
50+
- **Template Syntax**: Use template syntax to reference parameter values in cells. Requests like "Create a parameterized spreadsheet where A1 gets the number 42 and A2 gets 100 from parameters" are supported.
51+
52+
### Complex Structural Compositions
53+
54+
Design intricate spreadsheet layouts:
55+
56+
- **Multi-Section Layouts**: Create spreadsheets with multiple sections, headers, and totals. For instance, "Create a four-column spreadsheet with a header row, 4 data rows, and a SUM total row."
57+
- **Label/Value Layouts**: Design spreadsheets with label and value columns. Requests like "Create a two-column label/value layout with 4 rows" are possible.
58+
59+
### Feature Combinations
60+
61+
Combine multiple features for advanced spreadsheet designs:
62+
63+
- **Comprehensive Layouts**: Combine titles, instructions, custom column widths, bold headers, and more. For example, "Create a spreadsheet with a title, instructions, 4 columns with custom widths, a bold header row with background color, 4 data rows with alternating row colors, AVERAGE formulas in the last column, and assessed blank cells for missing values."
64+
65+
## Iterating and Refining Your Spreadsheets
66+
67+
L0166 supports iteration through the `update_item` feature, allowing you to refine and adjust your spreadsheets based on feedback or new requirements. You can modify existing elements, add new ones, or change styles and content as needed.
68+
69+
## Limitations and Cross-References
70+
71+
While L0166 is powerful for creating structured spreadsheets, it does not support advanced data analysis, chart creation, or external data integration. For these capabilities, consider using other Graffiticode languages such as L0200 for data analysis or L0300 for visualization.
72+
73+
Explore the full potential of L0166 to create tailored spreadsheet solutions that meet your specific needs.

0 commit comments

Comments
 (0)