Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ADD] - Contribution Guideline information to main Page section. #91

Closed
VerzatileDev opened this issue May 21, 2024 · 3 comments · Fixed by #92
Closed

[ADD] - Contribution Guideline information to main Page section. #91

VerzatileDev opened this issue May 21, 2024 · 3 comments · Fixed by #92
Assignees
Labels
📖 Type: Content Edits to documentation/content. 🌟 Type: Feature New feature or repository request.

Comments

@VerzatileDev
Copy link
Contributor

VerzatileDev commented May 21, 2024

Description:

Currently the base part of the contribution lies within the Wiki

Proposed Solution:

  • Aim to include the nessecary information to the main page and directions for new users. ❌
  • Improve the Wiki to address the guidelines of pages and how to add new ones. ❌

Additional Context

  • Write about required part of each page such as layout, link, navigation and search exclude or includes, etc.

Such as:

---
layout: default
title: Page Title & Information Title
permalink: /link.html
nav_exclude: true/false
search_exclude: true/false
nav_order: 1/2/3/4/etc
parent: - Previous folder the current section comes after see next reference.
---

image

In the following:

docs is a parent of Concepts
And
docs would be a grandparent to Polymorphism

  • In order to reference content or a section as a parent or grandparent its required that a reference to ".md " file is available such as a folder of Concepts Should include a file within the folder such as Concepts.md
@VerzatileDev VerzatileDev added 📖 Type: Content Edits to documentation/content. 🌟 Type: Feature New feature or repository request. labels May 21, 2024
@VerzatileDev
Copy link
Contributor Author

Setup, Extentsions used, Page Setup & Information, Writing New Pages, Limitations. Main Page of the Wiki Addressed

image

Page Links to be Added and written.

@VerzatileDev
Copy link
Contributor Author

Rearranged and additionally Added Sidebar for navigation in regards to the required content to contribute the way it was addressed originally.

image

@VerzatileDev
Copy link
Contributor Author

Arranged and touched almost every area required to write new content for new users.
image

@VerzatileDev VerzatileDev self-assigned this May 21, 2024
@VerzatileDev VerzatileDev linked a pull request May 21, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 Type: Content Edits to documentation/content. 🌟 Type: Feature New feature or repository request.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant