Merge pull request #4 from casper-network/dev

PR to deploy from main

Author: KMCreatesWorlds

.github/ISSUE_TEMPLATE/docs-feedback.md

@@ -0,0 +1,11 @@
+---
+name: Docs Feedback
+about: 'Please describe your feedback. Be as detailed as you can. If your feedback
+  is about a specific page or area, please be sure to include a link. '
+title: "[DOCS FEEDBACK]"
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feedback.yml

@@ -1,6 +1,6 @@
 name: Docs v2 Feedback Form
 description: Use this form to give us feedback on Docs v2
-title: 'Docs Feedback'
+title: '[Docs-V2-Feedback]'
 labels:
   - docs-v2-feedback
 body:
@@ -39,6 +39,6 @@ body:
     id: attachments
     attributes:
       label: Attachments (optional)
-      description: Please attach any logs, screenshots, or links.
+      description: Please attach any logs, screenshots, or links that may help with the analysis.
     validations:
-      required: false
+      required: false

.github/templates/overview-template.md

@@ -0,0 +1,16 @@
+<!-- This is a template for any "Overview" page. It helps us keep the reader experience consistent. -->
+<!-- An "Overview" page ties multiple topics together in a subsection of the docs. -->
+<!-- This template can be used at any nested level in the docs where there is an "Overview" page. Delete any sections you feel aren't relevant. -->
+
+# Overview
+
+## What is X?
+
+The main content of this page: include an overview of this section (all pages nested with and underneath this Overview) and replace "X" with the subject. This is especially useful for newer or less experienced developers, who might still be building a mental model.
+
+## Quick Links
+
+Users might already know where they want to go. To save time, include a list here of popular pages.
+
+You can also link up to the Portal, to the Concepts docs, or externally to help explain this topic.
+

.github/templates/pull_request_template.md

@@ -0,0 +1,22 @@
+### What does this PR fix/introduce?
+// Add a brief description or bullet points about the changes introduced. 
+// Include an issue number that is associated with this PR.
+
+Closes #<enter issue>
+
+### Additional context
+// Add further detail on the current situation, or what the PR seeks to address.
+// Include [loom](https://www.loom.com/), screenshots, or gifs([record](https://giphy.com/apps/giphycapture), [compress](https://gifcompressor.com/)) if helpful.
+
+### Checklist
+(Delete any that aren't relevant)
+
+- [ ] Docs are successfully building - `yarn install && yarn run build`.
+- [ ] For new **internal** links I used *relative file paths* (with .md extension) - e.g. `../../faq/faq-general.md` - instead of introducing *absolute file path*, or *relative/absolute URL*.
+- [ ] All external links have been verified with `yarn run check:externals`.
+- [ ] My changes follow the [Casper docs style guidelines](https://docs.casper.network/resources/contribute-to-docs/).
+- [ ] All technical procedures have been tested (if you want help with this, mention it in [Reviewers](#reviewers)).
+- [ ] If structural changes are introduced (not just content changes), cross-broswer testing has been completed.
+
+### Reviewers
+// Tag whoever needs to review. If you're not sure, leave blank.

.github/templates/tutorial-template.md

@@ -0,0 +1,58 @@
+<!-- This is a template to give you some rough structure for writing a tutorial.  -->
+<!-- Using a template means anyone can contribute and the experience for users reading the tutorials remains as consistent as possible. -->
+<!-- However, feel free to delete anything irrelevant to your tutorial.  -->
+<!-- If you need any help, tag our developer advocates or TW team. Thank you for contributing! -->
+
+# Tutorial Title
+
+## Overview
+Give a high-level overview of the tutorial. This helps the reader understand the scope of what they'll be doing end-to-end and potentially the basic architecture of what will speak to/interact with what.
+
+If relevant, include what they'll have achieved or built by the end of this tutorial.
+
+## Prerequisites
+
+This can include:
+- [ ] Recommended hardware/software/local setup
+- [ ] Familiarity/experience with Rust, JavaScript, at a certain level
+- [ ] Completion of a prior tutorial or process
+- [ ] Accounts or logins
+- [ ] Anything else that is relevant
+
+## Steps
+
+### Step 1
+
+Info here.
+
+### Step 2
+
+Info here.
+
+## Troubleshooting
+
+Advice on common questions or specific error messages that might pop up, or the support route if the user needs help.
+
+## Next Steps
+
+Further tutorials or docs to read once someone has successfully completed your tutorial.
+
+## Things to Remember
+
+### Tag your code snippets
+
+Remember to add the language when including any code blocks. While not supported natively by markdown, many markdown engines (including the one used by GitHub) will support syntax highlighting, which is helpful for reviewers and future maintainers of your tutorial:
+
+```
+    ```rust
+        let (contract_hash, contract_version) = 
+        storage::add_contract_version(contract_package_hash, 
+                                    entry_points, 
+                                    named_keys);
+    ```
+```
+
+
+### Single or multi-page tutorial?
+
+If your tutorial is long and you feel it would be easier to follow if split over multiple pages, create a folder and individual files, like this [Counter tutorial](../../source/docs/casper/resources/beginner/counter/index.md).

.github/workflows/branch-naming-policy.yml

@@ -0,0 +1,33 @@
+name: (DEV) Trigger Internal Build Pipeline
+
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  trigger-internal-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Extract Short Commit SHA
+        id: short_sha
+        run: |
+          echo "short_sha=$(git rev-parse --short "$GITHUB_SHA")" >> $GITHUB_OUTPUT
+
+      - name: Trigger Internal Build Workflow
+        uses: actions/github-script@v5
+        with:
+          github-token: ${{ secrets.PAT_TOKEN }}
+          script: |
+            await github.rest.actions.createWorkflowDispatch({
+              owner: 'casper-network',
+              repo: 'docs-infra',
+              workflow_id: 'build-redux-dev.yaml',
+              ref: 'main',
+              inputs: {
+                short_sha: '${{ steps.short_sha.outputs.short_sha }}'
+              }
+            });

.github/workflows/build-dev.yaml

@@ -0,0 +1,33 @@
+name: (PROD) Trigger Internal Build Pipeline
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  trigger-internal-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Extract Short Commit SHA
+        id: short_sha
+        run: |
+          echo "short_sha=$(git rev-parse --short "$GITHUB_SHA")" >> $GITHUB_OUTPUT
+
+      - name: Trigger Internal Build Workflow
+        uses: actions/github-script@v5
+        with:
+          github-token: ${{ secrets.PAT_TOKEN }}
+          script: |
+            await github.rest.actions.createWorkflowDispatch({
+              owner: 'casper-network',
+              repo: 'docs-infra',
+              workflow_id: 'build-redux-prod.yaml',
+              ref: 'main',
+              inputs: {
+                short_sha: '${{ steps.short_sha.outputs.short_sha }}'
+              }
+            });

.github/workflows/build-prod.yaml

@@ -0,0 +1,33 @@
+name: (STG) Trigger Internal Build Pipeline
+
+on:
+  push:
+    branches:
+      - stg
+
+jobs:
+  trigger-internal-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Extract Short Commit SHA
+        id: short_sha
+        run: |
+          echo "short_sha=$(git rev-parse --short "$GITHUB_SHA")" >> $GITHUB_OUTPUT
+
+      - name: Trigger Internal Build Workflow
+        uses: actions/github-script@v5
+        with:
+          github-token: ${{ secrets.PAT_TOKEN }}
+          script: |
+            await github.rest.actions.createWorkflowDispatch({
+              owner: 'casper-network',
+              repo: 'docs-infra',
+              workflow_id: 'build-redux-stg.yaml',
+              ref: 'main',
+              inputs: {
+                short_sha: '${{ steps.short_sha.outputs.short_sha }}'
+              }
+            });

.github/workflows/build-stg.yaml

@@ -128,3 +128,22 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# Dependencies
+/node_modules
+
+# Production
+build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.idea/
+CNAME

.gitignore

@@ -1,4 +1,10 @@
-## Version 2 of the casper documentation
+# Casper Network Documentation
+
+## Overview
+
+This is the documentation repository for the [Casper Network](https://casper.network/). 
+
+The documentation site itself may be viewed at this address: https://docs.casper.network/.
+
+For instructions on how to build, run, edit and contribute to this documentation please refer to the [developer documentation](./README/INDEX.md). 
 
-Preliminary hosting here: 
-[https://casper-devrel.github.io/docs-redux/](https://casper-devrel.github.io/docs-redux/)

cspr-docs/.vscode/settings.json .vscode/settings.json

@@ -0,0 +1,13 @@
+
+### Updating existing content
+
+1. Navigate to the `source/docs/casper` folder.
+2. Find the content you want to update and modify the markdown file(s). If you want to add new content, read the [Developer Guide](./DEVELOPERS.md) and the [Writing Style Guide](./writing-style-guide.md).
+3. [Run the website locally](#running-the-website-locally) to test your changes.
+4. Submit changes to the [documentation](https://github.com/casper-network/docs) using a pull request from your forked repository.
+
+**Note**: The website refreshes as you change the markdown files. However, if you change the structure or configuration of the website, you need to restart the application.
+
+### Adding new content
+
+Adding new content may require structural changes. Read the [Developer Guide](./DEVELOPERS.md) and the [Writing Style Guide](./writing-style-guide.md).