diff --git a/EDITING.md b/EDITING.md index bc21702..b9a5055 100644 --- a/EDITING.md +++ b/EDITING.md @@ -1,16 +1,16 @@ -# How to edit or modify vaaman-doc +# How to edit or modify the docs ## Cloning the repository Clone the fresh copy of this repository. ``` -git clone https://github.com/vicharak-in/vaaman-doc -b main -cd vaaman-doc +git clone https://github.com/vicharak-in/vicharak-docs -b main +cd vicharak-docs ``` If there already exists a local clone then do this instead ``` -cd +cd git fetch origin main git checkout FETCH_HEAD ``` @@ -69,9 +69,9 @@ Some examples on how to write good commit messages: Good: ``` -vaaman-doc: Introduce documentation for fgpa write. +vicharak-docs: Introduce documentation for fgpa write. README: Add usage documentation for windows users. -vaaman-doc: linux: Document different vaaman kernel revisions. +vicharak-docs: linux: Document different vaaman kernel revisions. ``` Bad: diff --git a/INSTALLATION-linux.md b/INSTALLATION-linux.md index 63852e3..fd4473c 100644 --- a/INSTALLATION-linux.md +++ b/INSTALLATION-linux.md @@ -28,7 +28,7 @@ pip install pipenv ### Install the dependencies inside python virtual environment -Use following command to setup python virtual environment for building **vaaman-doc**. +Use following command to setup python virtual environment for building docs. ```bash pipenv update @@ -44,6 +44,6 @@ pipenv shell --- -After successfully following the setup you have proper environment setup to build vaaman-doc. +After successfully following the setup you have proper environment setup to build vicharak-docs. Follow the [Editing Guide](./EDITING.md) for more information. diff --git a/INSTALLATION-windows.md b/INSTALLATION-windows.md index 509b62f..f7177f4 100644 --- a/INSTALLATION-windows.md +++ b/INSTALLATION-windows.md @@ -27,7 +27,7 @@ pip install pipenv > :warning: You can also directly use ./make.bat to setup virtualenv on your windows terminal. \ > Skip the following steps below if you are using ./make.bat to setup virtualenv -Use following command to setup python virtual environment for building **vaaman-doc**. +Use following command to setup python virtual environment for building docs. ```bash python -m pipenv update @@ -47,6 +47,6 @@ python -m pipenv shell --- -After successfully following the setup you have proper environment setup to build vaaman-doc. +After successfully following the setup you have proper environment setup to build vicharak-docs. Follow the [Editing Guide](./EDITING.md) for more information. diff --git a/README.md b/README.md index ca79b53..0fddfe7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Vicharak Vaaman Documentation -![build and deploy](https://github.com/vicharak-in/vaaman-doc/actions/workflows/build_and_deploy.yml/badge.svg) +![build and deploy](https://github.com/vicharak-in/vicharak-docs/actions/workflows/build_and_deploy.yml/badge.svg) reStructuredText/Markdown preferred documentation, generated using [Sphinx](https://www.sphinx-doc.org/en/master/usage/quickstart.html). diff --git a/SPELLING.md b/SPELLING.md index 370bf30..ee97f08 100644 --- a/SPELLING.md +++ b/SPELLING.md @@ -9,7 +9,7 @@ Assuming you are already inside python virtual environment. -To run the spelling checker on your local `vaaman-doc` source, use following command: +To run the spelling checker on your local `vicharak-docs` source, use following command: ```bash make spelling -j$(nproc --all) @@ -18,7 +18,7 @@ make spelling -j$(nproc --all)
Click to see output ``` -(vaaman-doc) ┌─[vicharak@galactos-bubuntu] in ~/vaaman-doc on utsav +(vicharak-docs) ┌─[vicharak@galactos-bubuntu] in ~/vicharak-docs on utsav └─[󰄛] make spelling -j32 sphinx-build -b spelling "source" "_build" Running Sphinx v6.2.1 @@ -30,7 +30,7 @@ Adding package names from PyPI to local dictionary… Ignoring Python builtins Ignoring importable module names Ignoring contributor names -Looking for custom word list in /home/vicharak/vaaman-doc/source/spelling_wordlist.txt +Looking for custom word list in /home/vicharak/vicharak-docs/source/spelling_wordlist.txt Scanning contributors myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'strikethrough', 'tasklist', 'deflist', 'colon_fence', 'smartquotes', 'linkify', 'attrs_block', 'attrs_inline'}, disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=True, heading_anchors=4, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True) building [mo]: targets for 0 po files that are out of date @@ -44,7 +44,7 @@ checking consistency... done preparing documents... done source/downloads.rst:7: : Spell check: Datasheets: ["Data sheets", "Data-sheets", "Dustsheets"]: Datasheets. source/downloads.rst:20: : Spell check: Pinouts: ["Pin outs", "Pin-outs", "Outpoints"]: Vaaman Pinouts Guide. -Writing /home/vicharak/vaaman-doc/_build/downloads.spelling +Writing /home/vicharak/vicharak-docs/_build/downloads.spelling writing output... [100%] vaaman-sdk WARNING: Found 2 misspelled words build succeeded, 1 warning. @@ -63,4 +63,4 @@ For the above two spelling mistakes, You can accept the suggestions provided by Replace `Datasheets` with `Data-sheets`. -Replace `Pinouts` with `Pin-outs`. \ No newline at end of file +Replace `Pinouts` with `Pin-outs`.