Skip to content
This repository was archived by the owner on Feb 18, 2025. It is now read-only.

Commit e1e3ae7

Browse files
Update issue templates
1 parent ba0d783 commit e1e3ae7

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: New content request
3+
about: Propose new content to be added to documentation
4+
title: ''
5+
labels: documentation
6+
assignees: khannanov-nil
7+
8+
---
9+
10+
**What is the product for which new content should be added?**
11+
It can be zkLLVM, Proof Market, zkSharding or Crypto3.
12+
13+
**How should new content fit into documentation?**
14+
It can be placed in an existing section or form an entirely new section.
15+
16+
**What topic should be covered by new content and what format should it take?**
17+
Provide a short description such as '*It would be nice to see a tutorial for constructing a zkRollup*' or '*Please add a new code example of EsDSA signature verification in Rust*'
18+
19+
**Why exactly should new content be added?**
20+
Justify adding new content, see the following examples for reference.
21+
* '*It is unclear how exactly `assigner` can be extended to support AIR arithmetization, a tutorial series is needed*'
22+
* '*The community needs to learn more about how the main shard communicates with execution shards in our L2, please add an explanation*'
23+
* '*I want to use a special build system to build the compiler but the documentation does not contain any instructions for this system. The system is fairly popular so the community will appreciate it if you add this info*'
24+
25+
**Additional context**
26+
Add any other context here.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Update/remove content request
3+
about: Propose changes to existing content
4+
title: ''
5+
labels: documentation
6+
assignees: khannanov-nil
7+
8+
---
9+
10+
**Where exactly should a change be made?**
11+
Provide a URL to the page/section where a change in existing content is needed.
12+
13+
**Why should existing content be changed?**
14+
Justify changing existing content. See the below examples for reference.
15+
* '*This code example does not compile into a circuit, please change it*'
16+
* '*This is not the correct flow for procuring a proof via Proof Market*'
17+
* '*This explanation of zkSharding is too long and complex. The community struggles with understanding it*'
18+
19+
**What would you like to see in place of existing content?**
20+
Provide a description of how the changed content is supposed to look like and what topics it should cover. See the below examples for reference.
21+
* '*The reason it doesn't compile is that...So please replace this function with something like this...*'
22+
* '*The new flow for procuring proofs is this: ...Add it to the docs and expand on it*'
23+
* '*Remove these terms: ... and make the explanation shorter by one paragraph*'
24+
25+
**Additional context**
26+
Add any other context about the changes here.

0 commit comments

Comments
 (0)