Skip to content

Commit de852d9

Browse files
committed
chore: Move Readmes content to Docs, refresh index and adjust Docusaurus configurations
Signed-off-by: Gabryel Nóbrega <gabryelster@gmail.com>
1 parent dd07374 commit de852d9

File tree

507 files changed

+5574
-9136
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

507 files changed

+5574
-9136
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+39-39
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
1-
---
2-
name: "\U0001F41E Bug report"
3-
about: Report a bug or known issue
4-
title: ''
5-
labels: 'type: bug'
6-
assignees: ''
7-
8-
---
9-
10-
Prior to submitting an issue, check to see if one has already been created. If there is currently an open issue, add a thumbs-up emoji to identify that it is also affecting you.
11-
12-
### Your Environment
13-
14-
- **Version:**
15-
- **Affected Scope:** docker, docussaurus, internationalization, docs, docs-spanish, docs-portuguese.
16-
- **Deployment Environment:** e.g. docker, baremetal, vs-code, docker compose, virtualbox.
17-
18-
### Describe the Issue
19-
20-
A clear and concise description of what the bug is.
21-
22-
#### To Reproduce
23-
24-
1. Go to '...'
25-
2. Click on '....'
26-
3. Scroll down to '....'
27-
4. See error
28-
29-
#### Expected behavior
30-
31-
A clear and concise description of what you expected to happen.
32-
33-
#### Screenshots
34-
35-
If applicable, add screenshots to help explain your problem.
36-
37-
#### Additional context
38-
39-
Add any other context about the problem here (e.g. logs).
1+
---
2+
name: "\U0001F41E Bug report"
3+
about: Report a bug or known issue
4+
title: ''
5+
labels: 'type: bug'
6+
assignees: ''
7+
8+
---
9+
10+
Prior to submitting an issue, check to see if one has already been created. If there is currently an open issue, add a thumbs-up emoji to identify that it is also affecting you.
11+
12+
### Your Environment
13+
14+
- **Version:**
15+
- **Affected Scope:** docker, docussaurus, internationalization, docs, docs-spanish, docs-portuguese.
16+
- **Deployment Environment:** e.g. docker, baremetal, vs-code, docker compose, virtualbox.
17+
18+
### Describe the Issue
19+
20+
A clear and concise description of what the bug is.
21+
22+
#### To Reproduce
23+
24+
1. Go to '...'
25+
2. Click on '....'
26+
3. Scroll down to '....'
27+
4. See error
28+
29+
#### Expected behavior
30+
31+
A clear and concise description of what you expected to happen.
32+
33+
#### Screenshots
34+
35+
If applicable, add screenshots to help explain your problem.
36+
37+
#### Additional context
38+
39+
Add any other context about the problem here (e.g. logs).
+36-36
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
1-
---
2-
name: "\U0001F680 Feedback form"
3-
about: Describe a problem, suggest a new idea or functionality for the project
4-
title: ''
5-
labels: 'type: feature'
6-
assignees: ''
7-
8-
---
9-
10-
### Your Environment (If applicable)
11-
12-
- **Version:**
13-
- **Affected Scope:** docker, docussaurus, internationalization, docs, docs-spanish, docs-portuguese.
14-
- **Deployment Environment:** e.g. docker, baremetal, vs-code, docker compose, virtualbox.
15-
16-
### Describe the problem
17-
18-
#### Description
19-
20-
A clear and concise description of what the problem is, under which scenarios or how frequent it happen
21-
22-
#### Additional context
23-
24-
Add any other context or screenshots about the problem here. You can also provide links to relevant resources.
25-
26-
### Describe your idea (optional)
27-
28-
A clear and concise description of any alternative solutions or features you've considered.
29-
30-
#### Additional context
31-
32-
Add any other context or screenshots about your solution.
33-
34-
#### Desired timelines
35-
36-
Share any information about timeline expectations.
1+
---
2+
name: "\U0001F680 Feedback form"
3+
about: Describe a problem, suggest a new idea or functionality for the project
4+
title: ''
5+
labels: 'type: feature'
6+
assignees: ''
7+
8+
---
9+
10+
### Your Environment (If applicable)
11+
12+
- **Version:**
13+
- **Affected Scope:** docker, docussaurus, internationalization, docs, docs-spanish, docs-portuguese.
14+
- **Deployment Environment:** e.g. docker, baremetal, vs-code, docker compose, virtualbox.
15+
16+
### Describe the problem
17+
18+
#### Description
19+
20+
A clear and concise description of what the problem is, under which scenarios or how frequent it happen
21+
22+
#### Additional context
23+
24+
Add any other context or screenshots about the problem here. You can also provide links to relevant resources.
25+
26+
### Describe your idea (optional)
27+
28+
A clear and concise description of any alternative solutions or features you've considered.
29+
30+
#### Additional context
31+
32+
Add any other context or screenshots about your solution.
33+
34+
#### Desired timelines
35+
36+
Share any information about timeline expectations.

.github/ISSUE_TEMPLATE/proposal.md

+36-36
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
1-
---
2-
name: "\U0001F4A1 Proposal"
3-
about: Propose a change to the Magma project
4-
title: ''
5-
labels: 'type: proposal'
6-
assignees: ''
7-
8-
---
9-
10-
<!--
11-
12-
Please start by reading the proposals process overview: https://docs.magmacore.org/docs/contributing/contribute_proposals
13-
14-
The key difference between a "feature request" and a "proposal" is the latter propose an actionable solution.
15-
16-
Proposal contents are not limited to particular topics, though the following are typical
17-
18-
- Process improvements
19-
- Design changes
20-
- Shift in project goals
21-
22-
For non-trivial proposals, consider following this standard pitch template, reproduced below in-part: https://github.com/kbariotis/templates/blob/master/templates/PITCH/TEMPLATE.md
23-
24-
-->
25-
26-
### Problem
27-
28-
The raw idea, a use case, or something that motivates acting on this proposal
29-
30-
### Solution
31-
32-
The core elements of the solution, presented concisely, targeting an audience with high-breadth but low-depth understanding of Magma
33-
34-
### Non-goals
35-
36-
Anything specifically excluded from the concept
1+
---
2+
name: "\U0001F4A1 Proposal"
3+
about: Propose a change to the Magma project
4+
title: ''
5+
labels: 'type: proposal'
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
12+
Please start by reading the proposals process overview: https://docs.magmacore.org/docs/contributing/contribute_proposals
13+
14+
The key difference between a "feature request" and a "proposal" is the latter propose an actionable solution.
15+
16+
Proposal contents are not limited to particular topics, though the following are typical
17+
18+
- Process improvements
19+
- Design changes
20+
- Shift in project goals
21+
22+
For non-trivial proposals, consider following this standard pitch template, reproduced below in-part: https://github.com/kbariotis/templates/blob/master/templates/PITCH/TEMPLATE.md
23+
24+
-->
25+
26+
### Problem
27+
28+
The raw idea, a use case, or something that motivates acting on this proposal
29+
30+
### Solution
31+
32+
The core elements of the solution, presented concisely, targeting an audience with high-breadth but low-depth understanding of Magma
33+
34+
### Non-goals
35+
36+
Anything specifically excluded from the concept

.github/PULL_REQUEST_TEMPLATE.md

+35-35
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
<!--
2-
Tag your PR title with the components that it touches along with
3-
the type of change
4-
E.g. "fix(docussaurus): spanish content configuration" or "feat(docker) ..."
5-
-->
6-
7-
## Summary
8-
9-
<!-- Enumerate changes you made and why you made them -->
10-
11-
## Test Plan
12-
13-
<!--
14-
How did you test your change? How do you know it works?
15-
Add supporting screenshots, terminal pastes, etc. as necessary
16-
-->
17-
18-
## Additional Information
19-
20-
- [ ] This change is backwards-breaking
21-
22-
<!--
23-
If this is a backwards-breaking change, document the upgrade instructions.
24-
Is any action necessary to upgrade an existing instance other than restarting?
25-
All upgrade instructions for backwards-breaking changes will be aggregated
26-
in the next release's changelog so this is very important to fill out.
27-
-->
28-
29-
## Security Considerations
30-
31-
<!--
32-
Comment on potential security impact. Could the change create or
33-
eliminate weaknesses? STRIDE, OWASP Top 10, or RFC 3552 may help.
34-
-->
35-
1+
<!--
2+
Tag your PR title with the components that it touches along with
3+
the type of change
4+
E.g. "fix(docussaurus): spanish content configuration" or "feat(docker) ..."
5+
-->
6+
7+
## Summary
8+
9+
<!-- Enumerate changes you made and why you made them -->
10+
11+
## Test Plan
12+
13+
<!--
14+
How did you test your change? How do you know it works?
15+
Add supporting screenshots, terminal pastes, etc. as necessary
16+
-->
17+
18+
## Additional Information
19+
20+
- [ ] This change is backwards-breaking
21+
22+
<!--
23+
If this is a backwards-breaking change, document the upgrade instructions.
24+
Is any action necessary to upgrade an existing instance other than restarting?
25+
All upgrade instructions for backwards-breaking changes will be aggregated
26+
in the next release's changelog so this is very important to fill out.
27+
-->
28+
29+
## Security Considerations
30+
31+
<!--
32+
Comment on potential security impact. Could the change create or
33+
eliminate weaknesses? STRIDE, OWASP Top 10, or RFC 3552 may help.
34+
-->
35+

0 commit comments

Comments
 (0)