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

resources and references #238

Merged
merged 2 commits into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ docs/building-on-flow/token-standards/flow-ft/*
docs/building-on-flow/token-standards/flow-nft/*
!docs/building-on-flow/token-standards/flow-nft/index.md

docs/.obsidian

# Remove after cadence is updated to a stable version
# https://github.com/onflow/docs/issues/105
# versioned_docs/version-stable/community-resources
Expand Down
Empty file.
32 changes: 32 additions & 0 deletions docs/community-resources/articles.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Articles
description: Dive into a wealth of insightful articles that provide in-depth knowledge, updates, and analysis on the Flow Blockchain, covering various topics to keep you informed and engaged.
sidebar_position: 4
sidebar_custom_props:
icon: 📰
---

import { allTutorials, nftTutorials, cadenceTutorials, architectureTutorials, videos } from '/src/data/pages/learn'

import { LargeVideoCard } from '/src/ui/design-system/src/lib/Components/VideoCard/LargeVideoCard'
import { PaginatedTutorialCardList } from "/src/ui/design-system/src/lib/Components/TutorialCard/PaginatedTutorialCardList"
import {
SmallVideoCard,
} from '/src/ui/design-system/src/lib/Components/VideoCard/SmallVideoCard'

## Cadence
<PaginatedTutorialCardList tutorials={cadenceTutorials} />

## NFTs
<PaginatedTutorialCardList tutorials={nftTutorials} />

## Architecture
<PaginatedTutorialCardList tutorials={architectureTutorials} />

## Videos
<LargeVideoCard {...videos.primary} />
{videos.secondary.map((videoProps) => (
<SmallVideoCard key={videoProps.link} {...videoProps} />
))}

### [Flow Youtube Channel](https://www.youtube.com/c/FlowBlockchain)
23 changes: 12 additions & 11 deletions docs/community-resources/developer-portal/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
sidebar_position: 2
sidebar_custom_props:
icon: 🥇
---
# Contributing to the Developer Portal
# Contributing to Flow Docs

Reading this document carefully will help you understand how to contribute your own content to the Developer Portal, and avoid problems along the way.
Reading this document carefully will help you understand how to contribute your own content to the Flow Docs, and avoid problems along the way.

In most cases you should be able to iterate and deploy changes to your documentation with no to little involvement the engineering team that is maintaining the Developer Portal.
In most cases you should be able to iterate and deploy changes to your documentation with no to little involvement the engineering team that is maintaining the Flow Docs.

## Getting Prepared

Expand Down Expand Up @@ -46,9 +47,9 @@ Updating existing content is a seamless process:

## Adding New Content

Expanding the Developer Portal with new content is straightforward:
Expanding the Flow Docs with new content is straightforward:

1. Markdown Mastery: To display content on the Developer Portal, use Markdown format. Markdown syntax resources are available for learning and reference:
1. Markdown Mastery: To display content on the Flow Docs, use Markdown format. Markdown syntax resources are available for learning and reference:
- [https://www.markdowntutorial.com/](https://www.markdowntutorial.com/)
- [https://www.markdownguide.org/](https://www.markdownguide.org/)

Expand Down Expand Up @@ -183,7 +184,7 @@ If you use `<DocCardList/>` on the top level category index page (e.g. `./docs/t

## SEO

Basic SEO metadata can be included in markdown `frontmatter`. The Developer Portal supports `title` and `description` metadata. If none is provided, a default will be applied.
Basic SEO metadata can be included in markdown `frontmatter`. The Flow Docs supports `title` and `description` metadata. If none is provided, a default will be applied.

Example `frontmatter`:

Expand All @@ -202,7 +203,7 @@ It is not required to supply this SEO metadata. Flow's in-house SEO experts will

### Images and Other Media

Include images and media using relative URLs within the `docs` folder. If your media is viewable in GitHub, then it should display on the Developer Portal.
Include images and media using relative URLs within the `docs` folder. If your media is viewable in GitHub, then it should display on the Flow Docs.

For external media or URLs, use fully qualified URLs, eg:

Expand All @@ -218,7 +219,7 @@ Linking to documents within the `docs` folder of your repo can be done in the st
[link](./doc-two.md#hash-link)
```

Writing links in your documents is easy if you follow this rule-of-thumb: If it works in GitHub it should work on the Developer Portal, with one notable exception.
Writing links in your documents is easy if you follow this rule-of-thumb: If it works in GitHub it should work on the Flow Docs, with one notable exception.

**Links to content outside the `docs` folder** in your repository, or elsewhere on the web must be in the form of a fully-qualified URL, eg:

Expand Down Expand Up @@ -256,7 +257,7 @@ Content is validated each time a PR is submitted to the `docs` repository.

Validation status is available in the **check run output** for your PR on GitHub.

Currently, the Developer Portal validates content using the following conditions:
Currently, the Flow Docs validates content using the following conditions:

- Do pages render without errors? This check accounts for errors in your markdown syntax.
- Are all links URLs valid? Broken links make for bad user experience.
Expand All @@ -267,13 +268,13 @@ Here is an example of check run output with successful validation.

### Dead Links Checks

The Developer Portal automatically scans relative links in *all your documents* when you submit changes to your docs. This is done to ensure that cross-links are valid, within your set of documentation.
The Flow Docs automatically scans relative links in *all your documents* when you submit changes to your docs. This is done to ensure that cross-links are valid, within your set of documentation.

## Content Previews

A special preview link is provided for content PRs as part of the GitHub PR check run.

Previews are generated against the **PR branch of the Developer Portal**, to ensure your content can be integrated with the latest updates to the Developer Portal itself.
Previews are generated against the **PR branch of the Flow Docs**, to ensure your content can be integrated with the latest updates to the Flow Docs itself.

Here is an example of preview output for changed documents in a PR

Expand Down
32 changes: 32 additions & 0 deletions docs/community-resources/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_position: 1
title: Community Resources
description: Access essential tools, knowledge, and community connections for the Flow Blockchain ecosystem.
---

import DocCardList from '@theme/DocCardList';
import { useDocsSidebar, isSamePath } from '@docusaurus/theme-common/internal';
import { useLocation } from '@docusaurus/router';

<DocCardList items={
[...useDocsSidebar().items.filter(item => !isSamePath(item.href, useLocation().pathname)),
{
type: 'link',
label: 'Flow Forum',
href: 'https://forum.onflow.org/',
description: 'Engage with the Flow community, discuss ideas, and seek support on the Flow Blockchain Forum.',
customProps: {
icon: "🏛️"
},
},
{
type: 'link',
label: 'FLIPs',
href: 'https://forum.onflow.org/',
description: 'Flow Improvement Proposals (FLIPs) serve as a platform for engaging the Flow community in development, harnessing the collective ideas, insights, and expertise of contributors and experts while ensuring widespread communication of design changes.',
customProps: {
icon: "📜"
},
},
]
}/>
21 changes: 21 additions & 0 deletions docs/community-resources/projects.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Community Projects
description: Explore the diverse projects and contributions within the Flow Blockchain community.
sidebar_position: 3
sidebar_custom_props:
icon: 🏟️
---

import {projects} from '/src/data/pages/community'
import ProjectCards from '/src/ui/design-system/src/lib/Components/ProjectCards/index.tsx'
import ProjectCard from '/src/ui/design-system/src/lib/Components/ProjectCard/index.tsx'

{/* <ProjectCards projects={projects} /> */}

Explore an array of exciting, grassroots initiatives, and projects that thrive within the Flow Blockchain community, each contributing to the platform's growth and innovation.

{projects.map((project, index) => (
<div className="mx-4 my-4">
<ProjectCard key={index} {...project} />
</div>
))}
Empty file removed docs/references/Introduction.md
Empty file.
24 changes: 24 additions & 0 deletions docs/references/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: References
---

# References
Quick references to very helpful parts of developer documentation. Languages to code up your applications and Network access points to pull blockchain data form Flow.
## Languages

- [HTTP API](/http-api) - Access node API
- [FCL JS](../tools/clients/fcl-js/api.md) - Flow Client Library (javascript and typescript)
- Flow SDKs
- [FCL SDK](../tools/clients/fcl-js/sdk-guidelines.mdx) - Flow Client Library SDK
- [Flow Go SDK](../tools/clients/flow-go-sdk/index.mdx) - Golang Flow Client SDK
- [Flow Unity SDK](https://unity-flow-sdk-api-docs.vercel.app/) - For gaming use the Unity SDK
- [Cadence](../cadence/language/functions.mdx) - Flow blockchain Smart Contract language, Cadence

## Network
Get Flow blockchain data from Access Nodes, both REST and gRPC endpoints are available. Get the current status of mainnet and testnet networks.

- [Flow Access API](../building-on-flow/nodes/access-api.mdx)
- [Mainnet](../building-on-flow/flow-networks/accessing-mainnet.md): `access.mainnet.nodes.onflow.org:9000`
- [Testnet](../building-on-flow/flow-networks/accessing-testnet.md): `access.devnet.nodes.onflow.org:9000`
- [Status Page](https://status.onflow.org/) - Network status page

4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -279,12 +279,12 @@ const config = {
label: 'Tools',
},
{
to: 'references/Introduction',
to: 'next/references',
position: 'left',
label: 'References',
},
{
to: 'community-resources/Introduction',
to: 'next/community-resources',
position: 'left',
label: 'Resources',
},
Expand Down
61 changes: 56 additions & 5 deletions src/data/pages/community.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,15 @@ export const projects: ProjectCardProps[] = [
githubLink: 'https://github.com/onflow',
},
{
projectImage:
'https://www.ecdao.org/wp-content/uploads/2022/08/EC-Education.svg',
projectImage: 'https://academy.ecdao.org/ea-logo.png',
heading: 'Emerald City',
description: 'The first DAO built on the Flow Blockchain',
tags: ['DAO'],
projectLink: 'https://www.ecdao.org/',
author: {
name: '',
name: 'Emerald City DAO',
profileImage:
'https://pbs.twimg.com/profile_images/1474074643866832897/zwutjUPS_400x400.jpg',
'https://pbs.twimg.com/profile_images/1687225095557632005/tUCmv8_P_400x400.jpg',
},
numStars: 0,
twitterLink:
Expand All @@ -91,7 +90,7 @@ export const projects: ProjectCardProps[] = [
author: {
name: 'Emerald City DAO',
profileImage:
'https://pbs.twimg.com/profile_images/1474074643866832897/zwutjUPS_400x400.jpg',
'https://pbs.twimg.com/profile_images/1687225095557632005/tUCmv8_P_400x400.jpg',
},
numStars: 0,
twitterLink:
Expand Down Expand Up @@ -149,6 +148,58 @@ export const projects: ProjectCardProps[] = [
twitterLink: 'https://twitter.com/_buildspace',
githubLink: 'https://github.com/buildspace',
},
{
projectImage:
'https://substackcdn.com/image/fetch/w_170,c_limit,f_auto,q_auto:best,fl_progressive:steep/https%3A%2F%2Fbucketeer-e05bbc84-baa3-437e-9518-adb32be77984.s3.amazonaws.com%2Fpublic%2Fimages%2F9c14b8ac-0937-4fe7-9893-46d907c108b7_899x899.png',
heading: 'Flowverse',
description:
'Flowverse is the central hub to discover everything on Flow Blockchain',
tags: ['NFT', 'Project'],
projectLink: 'https://www.flowverse.co/',
author: {
name: 'Flowverse',
profileImage:
'https://pbs.twimg.com/profile_images/1480354080123867138/66piiWGx_400x400.jpg',
},
numStars: 0,
twitterLink: 'https://twitter.com/flowverse_',
githubLink: 'https://twitter.com/flowverse_',
},

{
projectImage:
'https://pbs.twimg.com/profile_images/1689380364718850049/rCElOZT2_400x400.jpg',
heading: 'Flovatar',
description:
'Flovatar is a next generation NFT creativity platform where people can become creator and make their characters with any combination they like.',
tags: ['NFT', 'Project'],
projectLink: 'https://flovatar.com/',
author: {
name: 'crash13override',
profileImage: 'https://avatars.githubusercontent.com/u/1100260?v=4',
},
numStars: 0,
twitterLink: 'https://twitter.com/flovatar',
githubLink: 'https://github.com/crash13override/flovatar',
},

{
projectImage:
'https://pbs.twimg.com/profile_images/1685696696993341440/Qfh_-K41_400x400.jpg',
heading: 'Flowty',
description:
'Flowty is a one-stop shop for all of your NFT needs on the Flow blockchain. From buying and selling to NFT-backed loans to NFT rentals, we have you covered.',
tags: ['NFT', 'Project'],
projectLink: 'https://www.flowty.io/',
author: {
name: 'Flowty',
profileImage:
'https://pbs.twimg.com/profile_images/1685696696993341440/Qfh_-K41_400x400.jpg',
},
numStars: 0,
twitterLink: 'https://twitter.com/flowty_io',
githubLink: 'https://twitter.com/flowty_io',
},
];

export const secondaryNavSections = [
Expand Down