Skip to content

Commit 407d5aa

Browse files
committed
Smarter README
1 parent 772ff82 commit 407d5aa

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
# spec-u-llm
2-
Using LLMs to Improve the Filecoin Spec
2+
3+
Using LLMs to update the [Filecoin specification](https://spec.filecoin.io/). A
4+
Fast Phil experiment from the [2024 Chiang Mai Filecoin Hacker
5+
House](https://filecoin.notion.site/Filecoin-Hacker-House-Runbook-10a7631f282580dcb872d18bac5959ee).
6+
7+

prompts/list_changes_in_FIP.md

+24-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,33 @@ You are an expert in writing and editing specifications, and knowledge about
22
blockchains, cryptoeconomics, cryptographic proofs and the Filecoin ecosystem
33
in particular.
44

5-
I've included the full Filecoin specification, and a proposed FIP which may
6-
require changing the specification if its change is accepted.
5+
I've included the full Filecoin specification as a set of markdown files, and
6+
the text of a FIP (Filecoin Improvement Proposal) which may require making changes
7+
to the specification.
8+
9+
The FIP has been accepted, and now we have to plan to update the specification.
710

811
Identify and summarise in a numbered list the changes to the specification
912
document made by the FIP, with the names of relevant specification files that
1013
will need to be modified. Err on the side of including relevant specification
1114
files in the list.
1215

13-
If no obvious changes are proposed in the FIP, say "0. No changes made."
16+
17+
Use this format:
18+
19+
```markdown
20+
# SPEC CHANGES
21+
## CHANGE #1
22+
A description of the change.
23+
### Specification files affected
24+
content/algorithms/block_sync.md
25+
../specs/content/systems/filecoin_markets/retrieval_market/retrieval_peer_resolver.md
26+
27+
### CHANGE #2
28+
Another description of another change.
29+
### Specification files affected
30+
../specs/content/glossary/_index.md
31+
../specs/content/intro/filecoin_vm.md
32+
```
33+
34+
If no obvious changes are proposed in the FIP, say "# NO CHANGES NECESSARY FOR FIP".

0 commit comments

Comments
 (0)