renamed docs project name

nahieran-js-doc/src/App.js → docs/src/App.js

@@ -14,7 +14,7 @@ import './App.css';
 import useScrollToHash from 'hooks/useScrollToHash';
 import { DarkModeContext } from './helpers/context';
 import useLocalStorage from './hooks/useLocalStorage';
-import { GETTING_STARTED, RADIO_DOCS, TV_DOCS } from './docs';
+import { GETTING_STARTED, RADIO_DOCS, TV_DOCS, CONTRIBUTING } from './docs';
 
 function App() {
   useScrollToHash();
@@ -92,6 +92,12 @@ function App() {
                 </Box>)
               }
             </Box>
+
+            <Box id="Contributing">
+              <DocCard
+                title={CONTRIBUTING.title}
+                markdown={CONTRIBUTING.description} />
+            </Box>
           </Box>
         </Container>
       </ThemeProvider>

nahieran-js-doc/src/Components/AppBar.jsx → docs/src/components/AppBar.jsx

@@ -72,22 +72,18 @@ export default function MenuAppBar() {
               </IconButton>
             </Box>
 
-            {/* <img
-              src="/logo.svg"
-              alt="nahieran-js-logo"
-              style={{ width: "200px" }}
-            /> */}
-            <Typography variant="h4">
-              Nahieran
-              <span style={{ color: theme.palette.warning.main }}>JS</span>
-            </Typography>
+            <Link href="#getting-started" color="inherit" underline="none">
+              <Typography variant="h4">
+                Nahieran
+                <span style={{ color: theme.palette.warning.main }}>JS</span>
+              </Typography>
+            </Link>
             <Box
               sx={{
                 flexGrow: 1,
                 marginLeft: 5,
                 display: { xs: "none", md: "flex" },
               }}
-              // justifyContent="center"
             >
               {APPBAR_ITEMS.map((page, i) => (
                 <Link

nahieran-js-doc/src/Docs/general.js → docs/src/docs/general.js

@@ -1,6 +1,6 @@
 export const GETTING_STARTED = {
-    title:"Getting started",
-    description:`    
+    title: "Getting started",
+    description: `    
 A set of JS functions to use the EITB Nahieran API.
 
 This project is based on [https://github.com/erral/eitbapi-react](https://github.com/erral/eitbapi-react) project.
@@ -10,4 +10,18 @@ A very special thanks to [@erral](https://github.com/erral) for the contribution
 ~~~bash
 npm i nahieran-js
 ~~~`
+}
+
+export const CONTRIBUTING = {
+    title: "Contributing",
+    description:
+`
+## To run the development environment
+Go to /docs folder, install packages and start the project!
+
+~~~bash
+cd docs
+npm i
+npm run start
+`
 }

nahieran-js-doc/src/Docs/index.js → docs/src/docs/index.js

@@ -1,9 +1,10 @@
-import { GETTING_STARTED } from "./general";
+import { CONTRIBUTING, GETTING_STARTED } from "./general";
 import { TV_DOCS } from "./tv";
 import { RADIO_DOCS } from "./radio";
 
 export {
     GETTING_STARTED,
     TV_DOCS,
-    RADIO_DOCS
+    RADIO_DOCS,
+    CONTRIBUTING
 }