Skip to content

Commit

Permalink
add language guide (#1230)
Browse files Browse the repository at this point in the history
  • Loading branch information
fdncred committed Jan 28, 2024
1 parent 34b67aa commit 72085ff
Show file tree
Hide file tree
Showing 4 changed files with 487 additions and 0 deletions.
1 change: 1 addition & 0 deletions .vuepress/configs/navbar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ export const navbarEn: NavbarConfig = [
{ text: 'Commands', link: '/commands/' },
{ text: 'Cookbook', link: '/cookbook/' },
{ text: 'Blog', link: '/blog/' },
{ text: 'Ref', link: '/lang-guide/' },
];
8 changes: 8 additions & 0 deletions .vuepress/configs/sidebar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -150,4 +150,12 @@ export const sidebarEn: SidebarConfig = {
],
},
],
'/lang-guide/': [
{
text: 'Language Reference Guide',
link: '/lang-guide/README.md',
collapsible: false,
children: ['README.md', 'lang-guide.md'],
},
],
};
9 changes: 9 additions & 0 deletions lang-guide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Readme

In this section we have put together a start to a language guide.

The thought here is to have an outline where people can contribute in "small" ways in areas that they are familiar with.

There needs to be some topics added and I see that there are perhaps some duplicate areas that need to be cleaned up. I was kind of trying to mimic this document off of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/About and https://phel-lang.org/documentation/getting-started/. There may be others that we would prefer to model. Speak up if you have one.

The hope would be to provide a little bit of documentation text for context and then a lot of examples of usage.
Loading

0 comments on commit 72085ff

Please sign in to comment.