docs: reformat docs

IKatsuba · Sep 5, 2022 · b6600e8 · b6600e8
1 parent e6625f0
commit b6600e8
Show file tree

Hide file tree

Showing 21 changed files with 290 additions and 158 deletions.
diff --git a/.gitbook.yaml b/.gitbook.yaml
@@ -0,0 +1 @@
+root: ./docs
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -4,14 +4,14 @@ about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: IKatsuba
-
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,9 +24,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. macOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. macOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: enhancement
 assignees: IKatsuba
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -9,7 +9,7 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
@@ -30,40 +30,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2.3.4
+      - name: Checkout repository
+        uses: actions/checkout@v2.3.4
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1
diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml
@@ -8,7 +8,6 @@ on:
 env:
   PVM_LL: silly
 
-
 jobs:
   update:
     runs-on: ubuntu-latest

diff --git a/.prettierignore b/.prettierignore
@@ -2,3 +2,5 @@
 
 /dist
 /coverage
+
+docs/SUMMARY.md
diff --git a/README.md b/README.md
@@ -12,19 +12,19 @@ Let's look at a simple example of reading and writing a file using the native fe
 import { readFile, writeFile } from 'fs';
 
 readFile('src/some-file.js', (error, data) => {
+  if (error) {
+    console.error(error);
+    return;
+  }
+
+  writeFile('src/some-file.js', data, (error) => {
     if (error) {
-        console.error(error);
-        return;
+      console.error(error);
+      return;
     }
 
-    writeFile('src/some-file.js', data, (error) => {
-        if (error) {
-            console.error(error);
-            return;
-        }
-
-        console.log('Success!')
-    })
+    console.log('Success!');
+  });
 });
 ```
 
@@ -117,28 +117,27 @@ While working on the library, she looked at the RxJS logo and asked me, "Is this
 
 ## Packages
 
-* [x] [child\_process](libs/child-process.md)
-* [ ] cluster
-* [x] [crypto](libs/crypto.md)
-* [ ] dns
-* [ ] events
-* [x] [fs](libs/fs.md)
-* [x] [http](libs/http.md)
-* [ ] http2
-* [ ] https
-* [ ] inspector
-* [ ] net
-* [ ] process
-* [ ] readline
-* [ ] repl
-* [ ] stream
-* [ ] tls
-* [ ] tty
-* [ ] dgram
-* [ ] util
-* [ ] worker\_threads
+- [x] [child_process](docs/libs/child-process.md)
+- [ ] cluster
+- [x] [crypto](docs/libs/crypto.md)
+- [ ] dns
+- [ ] events
+- [x] [fs](docs/libs/fs.md)
+- [x] [http](docs/libs/http.md)
+- [ ] http2
+- [ ] https
+- [ ] inspector
+- [ ] net
+- [ ] process
+- [ ] readline
+- [ ] repl
+- [ ] stream
+- [ ] tls
+- [ ] tty
+- [ ] dgram
+- [ ] util
+- [ ] worker_threads
 
 ## We are supported by
 
 [![](.gitbook/assets/gitbook.svg)](https://www.gitbook.com/)[![](.gitbook/assets/jetbrains-variant-2.png)](https://www.jetbrains.com/?from=rxnode)
-
diff --git a/changelog.md b/changelog.md
@@ -4,19 +4,13 @@ title: Change Log
 ---
 
 ## v1.0.0
-**2022.09.04**
-
 
+**2022.09.04**
 
 ### 🚀 Features
 
-* update rxjs to v7 ([#4508d9c](https://github.com/IKatsuba/rxnode/commit/4508d9c170f5ed17892fc34d9b5b06eaa117fc54))
-
+- update rxjs to v7 ([#4508d9c](https://github.com/IKatsuba/rxnode/commit/4508d9c170f5ed17892fc34d9b5b06eaa117fc54))
 
 ### 💥 BREAKING CHANGES
 
-* update rxjs to v7
-
-
-
-
+- update rxjs to v7
diff --git a/code_of_conduct.md b/code_of_conduct.md
@@ -8,25 +8,25 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
 
   advances
 
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
 
   address, without explicit permission
 
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
 
   professional setting
 
@@ -51,4 +51,3 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
 This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
 
 For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)
-
diff --git a/contributing.md b/contributing.md
@@ -29,4 +29,3 @@ npm run test
 2. Update [README.md](./) to reflect changes related to public API and everything relevant
 3. Make sure you cover all code changes with unit tests
 4. When you are ready, create Pull Request of your fork into the original repository
-