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

[META] General structure, flow, & content enhancements #186

Merged
merged 34 commits into from
Oct 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
a1fe116
init guides section
salmad3 Aug 31, 2022
57d8d1f
edit section
salmad3 Sep 1, 2022
13ad805
Merge branch 'master' into guides
salmad3 Sep 1, 2022
6a9bc77
init
salmad3 Sep 7, 2022
f8704e2
add placeholder to examples sec
salmad3 Sep 7, 2022
6501fae
new struct for intro and core comp
salmad3 Sep 8, 2022
6f46894
Merge pull request #174 from libp2p/guides
salmad3 Sep 8, 2022
3758724
new struct for guide, ref, and involve sections
salmad3 Sep 8, 2022
410641f
edits edits
salmad3 Sep 13, 2022
4c2b7fc
more toc, edits
salmad3 Sep 13, 2022
3f182d8
rmv most placeholder docs + edits
salmad3 Sep 22, 2022
881ddae
edits + lp index
salmad3 Sep 22, 2022
ee8f867
sync with master and edit
salmad3 Oct 13, 2022
dc28bf6
chapterize subchapters
salmad3 Oct 13, 2022
2597183
edits
salmad3 Oct 14, 2022
5a1fa2a
mv dos mitigation to core components
salmad3 Oct 14, 2022
57bb28d
fix subchapters out of order
salmad3 Oct 14, 2022
f72842c
add required redirects
salmad3 Oct 14, 2022
16943a6
rmv temp dir for network basics until docs exist
salmad3 Oct 14, 2022
cefd581
simplify current chapters and notices, re-add descriptions
salmad3 Oct 14, 2022
7611874
define summary in frontmatter, rmv redundancy in ref docs and edits
salmad3 Oct 14, 2022
ebe71c9
incorporate PR feedback
salmad3 Oct 14, 2022
6ded166
rmv reference section, chapterize get involved and apply further redi…
salmad3 Oct 14, 2022
e01a645
edits
salmad3 Oct 14, 2022
212f848
completely simplify, rmv chapters, segment overviews, enhance present…
salmad3 Oct 14, 2022
2d37360
various edits, update summaries, fix assets, and more
salmad3 Oct 14, 2022
f342a2f
update descriptions for primary indexes
salmad3 Oct 14, 2022
12fa4fa
stub notice muxer content
salmad3 Oct 14, 2022
cab81a6
mv dos doc to components + edits
salmad3 Oct 17, 2022
a2d2bf8
add missing redirect to intro
salmad3 Oct 18, 2022
4ef04c5
add missing examples redirect
salmad3 Oct 18, 2022
2b8256d
merge master
salmad3 Oct 26, 2022
8681f36
update frontmatter for hole punching + edit
salmad3 Oct 26, 2022
be8f293
one more edit
salmad3 Oct 26, 2022
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
Binary file added .DS_Store
Binary file not shown.
14 changes: 11 additions & 3 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ baseURL = "https://docs.libp2p.io"
relativeURLs = true
languageCode = "en-us"
title = "libp2p Documentation"
summaryLength = 20

theme = "hugo-theme-learn"
theme = ["hugo-theme-learn"]

[params]
themeVariant = "libp2p"
Expand All @@ -18,12 +19,19 @@ url = "https://libp2p.io"
weight = 1

[[menu.shortcuts]]
name = "<i class='fab fa-github'></i> libp2p Github"
name = "<i class='fab fa-github'></i> libp2p GitHub"
url = "https://github.com/libp2p/libp2p"
weight = 2

[[menu.shortcuts]]
name = "<i class='fab fa-github'></i> libp2p Specs"
url = "https://github.com/libp2p/specs"
weight = 3

[[menu.shortcuts]]
name = "<i class='fab fa-discourse'></i> Discussion Forums"
url = "https://discuss.libp2p.io"
weight = 3
weight = 4

[markup.goldmark.renderer]
unsafe = true # Allow HTML in md files
Binary file added content/.DS_Store
Binary file not shown.
23 changes: 5 additions & 18 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,16 @@
---
title: libp2p documentation portal
title: libp2p Documentation Portal
menuTitle: libp2p
weight: 1
pre: "<b>1. </b>"
pre: "<b> </b>"
chapter: true
---

# libp2p Documentation Portal
# Welcome to the Documentation Portal

Welcome to the libp2p documentation portal! Whether you’re just learning how to build peer-to-peer systems with libp2p, want to dive into peer-to-peer concepts and solutions, or are looking for detailed reference
Welcome to the libp2p Documentation Portal! Whether you’re just learning how to build peer-to-peer systems with
libp2p, want to dive into peer-to-peer concepts and solutions, or are looking for detailed reference
information, this is the place to start.

{{% children description="true" %}}

{{% notice "note" %}}
This section is incomplete, and many of the articles are stubs. To help fill in
the gaps, please see the issues linked in each article to add your input and
help us prioritize the outstanding work.
{{% /notice %}}

### Related Projects

libp2p began as part of the [IPFS](https://ipfs.io) project, and is still an essential component of IPFS. As such, libp2p composes well with the abstractions and tools provided by other projects in the IPFS "family". Check their individual sites for specific information and references:

- [IPFS](https://ipfs.io) is the InterPlanetary File System, which uses libp2p as its networking layer.
- [Multiformats](https://multiformats.io) is a variety of *self-describing* data formats.
- [IPLD](https://ipld.io) is a set of tools for describing links between content-addressed data, like IPFS files, Git commits, or Ethereum blocks.
- [The Permissive License Stack](https://protocol.ai/blog/announcing-the-permissive-license-stack) is a licensing strategy for software development that embraces open-source values.
12 changes: 7 additions & 5 deletions content/community/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: "Community"
weight: 10
pre: '<i class="fas fa-fw fa-lightbulb"></i> '
weight: 5
pre: '<i class="fas fa-fw fa-newspaper"></i> '
chapter: true
summary: Get in touch with other members working on or with libp2p, learn how to contribute, and become an active participant in the libp2p community.
---

Get in touch with other members of the libp2p community who are building tools and applications with libp2p! You can ask questions, discuss new ideas, or get support for problems at [libp2p discussion forums](https://discuss.libp2p.io/), but you can also [hop on IRC](/community/irc/) for a quick chat.
# Get Involved with libp2p

See the other links in the community section for more information about meetings, events, apps people are building, and more.
Find out how to get involved with libp2p and join the community.

Information about contributing to libp2p and about other software projects in the community are also hosted here.
{{% children description="true"%}}
10 changes: 7 additions & 3 deletions content/discuss/_index.md → content/community/community.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
---
title: "Help & Discussion"
weight: 100
pre: "<i class='fas fa-fw fa-question-circle'></i> "
title: "Get Involved"
weight: 1
pre: '<i class="fas fa-fw fa-book"></i> <b> </b>'
chapter: true
summary: Get involved and participate in the libp2p community.
---

# Get Involved

We love talking about libp2p, and we'd be happy to have you in the mix.

Visit our [discussion forums](https://discuss.libp2p.io) to ask questions about [using libp2p](https://discuss.libp2p.io/c/users), discuss exciting [research](https://discuss.libp2p.io/c/research), and [stay up to date with important announcments](https://discuss.libp2p.io/c/news).
Expand Down
33 changes: 19 additions & 14 deletions content/contributing/_index.md → content/community/contribute.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
---
title: "Get Involved"
weight: 10
pre: '<i class="fas fa-fw fa-heart"></i> '
title: "How to Contribute"
weight: 2
pre: '<i class="fas fa-fw fa-book"></i> <b> </b>'
chapter: true
summary: Learn how you can contribute to libp2p.
---

# How to Contribute

So you want to contribute to libp2p and the peer-to-peer ecosystem? Here is a quick listing
of things we need help with and how you can get started. Even if what you want
to do is not listed here, we probably accept contributions for it! If you're
unsure, please open a issue.

## Areas of contribution
- [Areas of contribution](#areas-of-contribution)
- [Code](#code)
- [Documentation](#documentation)
- [Support](#support)
- [Testing](#testing)
- [Design](#design)
- [Issues / Triaging](#issues--triaging)
- [Community](#community)
- [Applications](#applications)
- [Protocol Design](#protocol-design)
- [Research](#research)
- [How to Contribute](#how-to-contribute)
- [Areas of contribution](#areas-of-contribution)
- [Code](#code)
- [Documentation](#documentation)
- [Support](#support)
- [Testing](#testing)
- [Design](#design)
- [Issues / Triaging](#issues--triaging)
- [Community](#community)
- [Applications](#applications)
- [Protocol Design](#protocol-design)
- [Research](#research)

### Code

Expand Down
19 changes: 9 additions & 10 deletions content/concepts/_index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
title: "Core Components"
title: Core Components
weight: 2
pre: '<i class="fas fa-fw fa-lightbulb"></i> '
pre: '<i class="fas fa-fw fa-clone"></i> '
chapter: true
aliases: /reference/specs/
summary: libp2p covers a lot of ground, and may involve unfamiliar terminology and concepts. This section goes over the foundational concepts involved in libp2p.
---

libp2p covers a lot of ground, and may involve unfamiliar terminology and concepts.
This section goes over the foundational concepts involved in libp2p.
# Learn about libp2p

{{% children %}}
libp2p covers a lot of ground, and may involve unfamiliar terminology and concepts.
This chapter goes over the foundational concepts involved in libp2p.

{{% notice "note" %}}
This section is incomplete, and many of the articles are stubs. To help fill in
the gaps, please see the issues linked in each article to add your input and
help us prioritize the outstanding work.
{{% /notice %}}
{{% children description="true"%}}
8 changes: 0 additions & 8 deletions content/concepts/content-routing.md

This file was deleted.

Loading