Skip to content

Commit

Permalink
Add isHidden to courses and hide outdated Unboxed courses (#316)
Browse files Browse the repository at this point in the history
* Add 'courses' to README.md, minor fixes.

Remove dead code

* Add isHidden() to courses

* Hide connecting-to-offchain-data and native-onchain-development courses
  • Loading branch information
mikemaccana authored Aug 20, 2024
1 parent 7ad742e commit bf2365a
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 12 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,18 @@ the Solana ecosystem and displayed on

There are a few primary types of Solana Developer content within this repo:

- [`docs`](#solana-docs) - The [core documentation](https://solana.com/docs) for
the Solana blockchain
- [`guides`](#developer-guides) - Long form tutorials focused on a specific
- [`courses`](#cources) - multiple lessons comprehensively covering a given
topic, with both a read session and and an interactive lab for each lesson
- [`docs`](#docs) - the [core documentation](https://solana.com/docs) for the
Solana blockchain
- [`guides`](#developer-guides) - long form tutorials focused on a specific
topic related to Solana development, like building dApps and programs
- [`resources`](#developer-resources) - Collection of the popular frameworks,
sdks, documentation sites, and developer tools from around the ecosystem
- [`resources`](#developer-resources) - collection of popular frameworks, SDKs,
documentation sites, and developer tools from around the ecosystem

### Solana Docs
### Courses

### Docs

The core [Solana Documentation](https://solana.com/docs) is housed within this
repo, including the documentation for the
Expand All @@ -29,8 +33,7 @@ repo, including the documentation for the
The "core documentation" within this repo is generalized to the Solana protocol
as a whole and not the specific implementations of any given Validator client.

If you are looking for the documentation of a specific Validator client's
implementation, consult their respective documentation:
For specific validator clients, consult their respective documentation:

| Validator Client | Repo | Website |
| ------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------ |
Expand Down
1 change: 1 addition & 0 deletions content/courses/connecting-to-offchain-data/metadata.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ lessons:
- oracles
- verifiable-randomness-functions
priority: 20
isHidden: true
3 changes: 2 additions & 1 deletion content/courses/native-onchain-development/metadata.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
author: unboxed
title: Native onchain program development
description: "Learn how to build Solana programs without using Anchor."
description: "Learn how to build Solana programs without using Anchor."
lessons:
- hello-world-program
- deserialize-instruction-data
Expand All @@ -12,3 +12,4 @@ lessons:
- deserialize-custom-data-frontend
- paging-ordering-filtering-data-frontend
priority: 50
isHidden: true
11 changes: 11 additions & 0 deletions contentlayer.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,17 @@ export const CourseRecord = defineDocumentType(() => ({
type: "number",
resolve: () => DEFAULT_PRIORITY,
},

// Some of the Unboxed courses are out of date, so they are hidden from the
// UI (their URLs remain available to editors and users that know them)
// while we get them updated.
isHidden: {
type: "boolean",
description:
"Hide this course from the course list (does not affect URL availability)",
required: false,
default: false,
},
},
}));

Expand Down
3 changes: 0 additions & 3 deletions src/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,6 @@ type NavItemBase = {
href?: string;
sidebarSortOrder?: number;
metaOnly?: boolean;
/**
*
*/
items?: Array<any>;
altRoutes?: string[] | undefined;
isSkippedInNav?: boolean;
Expand Down

0 comments on commit bf2365a

Please sign in to comment.