Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Structure languages #77

Merged
merged 9 commits into from
May 25, 2021
Merged

Structure languages #77

merged 9 commits into from
May 25, 2021

Conversation

jeremyw24
Copy link
Contributor

This PR:

  • Moves Typescript under a Languages sub-category in the overview section.
  • Adds Crystal Lang Overview
  • Adds spider-gazelle section to Crytal

- added language sub category
- moved typescript to sub category
- created crystal page
@vercel
Copy link

vercel bot commented May 24, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/placeos/docs/AKwpwdJgoVb6sHq6VgANp6faNkii
✅ Preview: Failed

[Deployment for 8e482d6 failed]

@jeremyw24 jeremyw24 self-assigned this May 24, 2021
Copy link
Contributor

@kimburgess kimburgess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overview/Languages -> overview/languages: for consistency, would be good to keep the directory tree downcased.

I'd also suggest that Spider-Gazelle can be omitted from here. Two reasons for this:

  1. It's a framework, not a language.
  2. It is not something that related to usage of PlaceOS, or any user extensible parts of the platform.

It is generally useful, but has it's own documentation site for that purpose. Inclusion here just adds noise.

@jeremyw24
Copy link
Contributor Author

@kimburgess there is a bug here where downcasing the directory causes said directoy to appear in the navigation tree in lowercase.

Setting the folder name with uppercase Languages will cause it to display correctly in the navigation tree.

I have just amended to lowercase languages while removing spider-gazelle content and confirmed the above observation to be correct.

For aesthetics, I will uppercase the directory again so we can proceed with this PR. Suspect this needs to be raised as a bug against docusaurs?

From _category_.yml

label: Languages
position: 1
collapsed: false

Noting this is ignored.

image

@kimburgess
Copy link
Contributor

Looks like you're missing a trailing underscore on that _categeory_.yml so it's being ignored at the moment. Default behaviour without that is to just use the directory name.

Copy link
Contributor Author

@jeremyw24 jeremyw24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes have been made.

@jeremyw24 jeremyw24 merged commit fdf94a2 into main May 25, 2021
@jeremyw24 jeremyw24 deleted the structure-languages branch May 25, 2021 04:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants