Skip to content

Commit

Permalink
Added links to "Answers to few questions" section in README
Browse files Browse the repository at this point in the history
- Added direct links to the "Answers to few questions" section in the README.
- This makes it easier for users to find the section and follow the steps or get answers to common questions.
- Improved navigation within the documentation for better user experience.
  • Loading branch information
vidipsingh authored Dec 30, 2024
1 parent 86d6053 commit 1841c3c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,10 @@ The code has been restructured, unnecessary code has been removed, comments were
1. Whenever the code is changed, please ensure that the relevant code changes are reflected in **main.js** file (For example, if a slideshow is disabled, make sure the id of the slideshow element/section is also disabled in the **main.js** file if it exists).
2. Few dependencies/libraries do not work well with other dependencies/libraries, so make sure to test before updating the dependencies/libraries.
3. Whenever the website hosting is shifted to another url/domain, please ensure to change the internal url references and also the **sitemap.txt** file.
4. Do check **Answers to a few questions** section to get answers to a few of the questions you might have or for steps to be followed.
4. Do check [**Answers to Few Questions**](https://github.com/sugarlabs/www?tab=readme-ov-file#answers-to-few-questions) section to get answers to few of the questions you might have or for steps to be followed.
5. Be careful when changing the cache control code present in the **.htaccess** file.
6. Whenever the dependency/library versions are changed, please update the local files of those dependencies as these local files are referenced when the cdn does not work.
7. The current website uses customized versions of a few social media icons (service provided by [Ion Icons](https://ionicons.com)). We do our customizations in a scss file (**/css/ion_icon_customization.scss** file in our case). Please be careful when updating this file. (Also refer to **How to change social media icon colors?** the subsection in **Answers to few questions** section)
7. The current website uses customized versions of a few social media icons (service provided by [Ion Icons](https://ionicons.com)). We do our customizations in a scss file (**/css/ion_icon_customization.scss** file in our case). Please be careful when updating this file. (Also refer to [**How to change social media icon colors?**](https://github.com/sugarlabs/www?tab=readme-ov-file#how-to-change-social-media-icon-colors) the subsection in [**Answers to Few Questions**](https://github.com/sugarlabs/www?tab=readme-ov-file#answers-to-few-questions) section)

## Some Developer Notes
All internal URLs are referenced through absolute paths and not relative paths. This website primaritally uses HTML, (S)CSS, Javascript, JQuery, and Bootstrap.
Expand Down Expand Up @@ -196,7 +196,7 @@ The loader screen is enabled for:
To reduce animations, we disabled the loader for all the other browsers.

### Font:
The font being used is the Google font, Varela round. When we call the font sheet directly, it is not properly rendered on certain browsers, so we hosted the required font sheets in the **fonts** folder itself. For more details, please refer to **How to add/change the new font?** the subsection in the **Answers to a few questions** section.
The font being used is the Google font, Varela round. When we call the font sheet directly, it is not properly rendered on certain browsers, so we hosted the required font sheets in the **fonts** folder itself. For more details, please refer to **How to add/change the new font?** the subsection in the [**Answers to Few Questions**](https://github.com/sugarlabs/www?tab=readme-ov-file#answers-to-few-questions) section.

### Design Layout of Website/Project

Expand Down

0 comments on commit 1841c3c

Please sign in to comment.