From f756c0c8f2143f58a7c8b6d11ce093f243f238ed Mon Sep 17 00:00:00 2001 From: Konrad Szwarc Date: Sat, 28 Jan 2023 20:00:41 +0100 Subject: [PATCH] Update README --- README.md | 2 +- docs/README.md | 2 -- docs/SUMMARY.md | 2 +- docs/{quick-setup-guide.md => setup-guide.md} | 2 +- 4 files changed, 3 insertions(+), 5 deletions(-) rename docs/{quick-setup-guide.md => setup-guide.md} (98%) diff --git a/README.md b/README.md index 8e0a63e..f35aef4 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ A fully customizable template to create your online (and paper) resume without w To learn how to set up your resume, go to: -[https://devscard.gitbook.io/docs](https://devscard.gitbook.io/docs/) +[https://devscard.gitbook.io/docs](https://devscard.gitbook.io/docs/setup-guide) ## Example diff --git a/docs/README.md b/docs/README.md index e61191f..50c1182 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,5 @@ # Introduction -## What is DevsCard? - DevsCard is a fully customizable template to create your online resume without writing a single line of code. After forking the repository, you only need to update the initial data with your own and deploy the project. Apart from the website template, DevsCard offers you plenty of additional features that will make it easier to take care of your online and offline presence, including: diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 66551e6..3442c99 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,7 +1,7 @@ # Table of contents - [Introduction](README.md) -- [Setup guide](quick-setup-guide.md) +- [Setup guide](setup-guide.md) - [PDF generation](pdf-generation.md) - [Data transformation](data-transformation.md) diff --git a/docs/quick-setup-guide.md b/docs/setup-guide.md similarity index 98% rename from docs/quick-setup-guide.md rename to docs/setup-guide.md index 1268596..be291cd 100644 --- a/docs/quick-setup-guide.md +++ b/docs/setup-guide.md @@ -35,7 +35,7 @@ To fill the CV with your data, go to the `src/data` directory. There you should ## 3. Generate PDF (optional) -Within the main section, you will find an `action` property. It allows you to provide a pdf resume to download. If you don't have one, feel free to use our CV generator by invoking `npm run generate-pdf`. Generated resume will be placed in `public/cv.pdf` and use the same data as the web one. You can learn more about PDF generation [here](quick-setup-guide.md). +Within the main section, you will find an `action` property. It allows you to provide a pdf resume to download. If you don't have one, feel free to use our CV generator by invoking `npm run generate-pdf`. Generated resume will be placed in `public/cv.pdf` and use the same data as the web one. You can learn more about PDF generation [here](./pdf-generation.md). ## 4. Deploy to Netlify