From 9b51b5c39f0017f7aeae62771cad27ca3e838ed0 Mon Sep 17 00:00:00 2001 From: Giga Bob <62410139+Bobinstein@users.noreply.github.com> Date: Mon, 9 Oct 2023 20:31:01 -0400 Subject: [PATCH] docs: permasite page (#16) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: merge production into staging (#7) * chore: merge staging into production (#6) * mdBook * readme wip * readme.md updated from https://stackedit.io/ * readme.md updated from https://stackedit.io/ * readme.md updated from https://stackedit.io/ * readme.md updated from https://stackedit.io/ * demo * readme.md updated from https://stackedit.io/ * readme.md updated from https://stackedit.io/ * readme.md updated from https://stackedit.io/ * readme.md updated from https://stackedit.io/ * readme.md updated from https://stackedit.io/ * readme.md updated from https://stackedit.io/ * Building navigation * Added arfs 0.11 and 0.12 * completed proposal * init * feat: :art: updated for light/dark, other configs updated the app with the code for light/dark modes, made some other configuration changes. * style: :art: css changes stylized prev/next, added borders, color changes, other changes from whitepaper docs * fix: :bug: build script fix fixed depreciated build script * Update deploy.yml * set vuepress dist folder correctly * add base back * style: :art: fixed subheader color subheader color now matches general text color * refactor: removed about section about section existed as a workaround for sidebar defaulting to open, replaced it with price calclulator * docs: :memo: updated landing page replaced placeholder home page with content from ardrive.io * refactor: :memo: added new default page to /cli/, bug fixes replaced readme.md as the landing page for /cli/, fixed error with variable not being initialized. * docs: :memo: added arfs overview overview landing page for arfs * fix: :bug: fixed metadata fixed project metadata so it no longer shows whitepaper * fix: :art: fix logo on light mode logo was not displaying on light mode, cannot recreate locally. pushing possible fix * fix: :bug: log fix another attempt to fix the logo bug * fix: :bug: logo fix defaulted to uncustomized logo src because switching is not needed * fix: :bug: logo fix lets try this fix * style: :art: search box styling basic search box and result styling for readability, will need further input * docs: :memo: inline code styling, added docs created css to target inline code only, will need to be adjusted to team preference. Added some ArFS documentation * docs: :memo: ArFS docs more ArFS documentation. * docs: :memo: ArFS docs additional docs for ArFS * docs: :memo: ArFS Docs ArFS docs, based on confluence post from Phil, have been added up to Operations * refactor: title change changed title from ardrive.io to ArDrive Docs * h2 border-bottom * h2 line styling * added Snapshot entity information * style: :art: style changes several style changes, added customized search box component, replaced discord text with logo, still need to even out SVGs * fixed search result colors * added magnifying glass to search bar for visual * SearchBox styling changes * style changes * docs: :art: added more ArFS docs, styling changes added usage docs, set up sidebar - no custom sidebar yet, styling changes - need to identify issue with sidebar subheader coloring * turned 'last updated' off * style: :art: style changes several style changes suggested by Jonathan * style: :art: changed sidebar order moved core sdk up in sidebar because if the first item has a dropdown it will always start open * style: :art: style changes several style changes suggested by jacob * fix: :bug: fixed links link references were broken when cli file was split. corrected * style: :art: prev / next styling styled the prev and next buttons * style: :art: fixed sidebar item color found and removed rule givinig some sidebar items an opacity * style: :art: minor style changes minor style changes * docs: :art: added overview tag all sections except price calculator now begin with the overview header * sidebar change * style: :art: adjusted nav icons * change prev/next button background color in dark mode * added CNAME file * changed base path * fixed logo path * capitalize page description * added plausible script * Made ArDrive logo larger * Updated data-model.md * added Overview to price Calculator * added meta image * changed support link * spaced nav icons * merge from staging * merge conflicts resolved * completely functional, needs styling * style: :art: set basic styling for the seach modal * updated modal styling * updated ArFS Overview * Added copy button to code blocks using 'vuepress-plugin\-code-copy' plugin * docs: :memo: Updated ArFS documentation Updated ArFS documentation to match recent atlassian updates. * docs: added deployment docs added docs explaining how to deploy a dApp using the ArDrive web app. * docs: added deploy docs added docs for deploying dApps using the ArDrive web app * fix: fixed bug preventing build syntax for removing prev/next buttons on certain pages was incorrect and prevented build. commented out. * refactor: Corrected syntax to remove prev/next corrected the syntax commented out in the previous commit. Unneeded prev/next buttons removed without affecting build * docs: Added Examples page Added page with example websites for deploying a dApp to Arweave * docs: Added Turbo API docs Added preliminary docs for the Turbo Payment and Upload APIs * docs: typo correction replaced AR with data when referring to amount of data that can be uploaded * docs: Added openapi docs links Added disclaimer about docs being up to date, and linked to openapi docs which are maintained as changes are made. * chore: created package-lock.json file created package-lock.json so users can install dependencies with npm without issue. * fix: Fixed Zendesk link * docs(turbo): update CLI and Core docs with Turbo release PE-4435 (#4) --------- Co-authored-by: agsuy Co-authored-by: agsuy <37564412+agsuy@users.noreply.github.com> Co-authored-by: Phil Co-authored-by: Karl Prieb Co-authored-by: Derek Sonnenberg * feat(markdown files): adds documentation for Pins; applies minor clarifications PE-4497 (#5) Co-authored-by: Giga Bob <62410139+Bobinstein@users.noreply.github.com> --------- Co-authored-by: agsuy Co-authored-by: agsuy <37564412+agsuy@users.noreply.github.com> Co-authored-by: Phil Co-authored-by: Karl Prieb Co-authored-by: Derek Sonnenberg Co-authored-by: Matías Batista * chore: changed deploy to production instead of staging * fix: fixed visual bug in navbar * docs: Added Turbo-SDK doc * chore: update example in turbo sdk readme (#10) * chore: update examples * chore: fix links * docs: Added permasite page * docs: Permasite docs update * fix: fix typo * docs: update to permasite page * docs: Update and publish permasite page --------- Co-authored-by: agsuy Co-authored-by: agsuy <37564412+agsuy@users.noreply.github.com> Co-authored-by: Phil Co-authored-by: Karl Prieb Co-authored-by: Derek Sonnenberg Co-authored-by: Matías Batista Co-authored-by: Dylan Fiedler --- .../src/.vuepress/theme/configs/default_sidebar_config.js | 8 ++++---- docs/src/docs/misc/permasite.md | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/src/.vuepress/theme/configs/default_sidebar_config.js b/docs/src/.vuepress/theme/configs/default_sidebar_config.js index e6b7bb8..25b7d4d 100644 --- a/docs/src/.vuepress/theme/configs/default_sidebar_config.js +++ b/docs/src/.vuepress/theme/configs/default_sidebar_config.js @@ -132,10 +132,10 @@ module.exports = [ { title: "Misc.", children: [ - // { - // title: "Permasites", - // path: "/docs/misc/permasite" - // }, + { + title: "Permasites", + path: "/docs/misc/permasite" + }, { title: "Price Calculator", path: "/docs/misc/price-calculator", diff --git a/docs/src/docs/misc/permasite.md b/docs/src/docs/misc/permasite.md index 376332c..4544fef 100644 --- a/docs/src/docs/misc/permasite.md +++ b/docs/src/docs/misc/permasite.md @@ -8,6 +8,9 @@ Resources like the [Wayback Machine](https://archive.org/web/) are useful to res The process to make a ‘permasite’ takes 10 steps which are outlined below. Advanced users can accomplish similar results by using manifests within the [ArDrive CLI](../cli/intro.md). +You can view a permasite version of this information at [permasite.arweave.dev](https://permasite.arweave.dev) + + ## 1. Download Static Site Files ArDrive allows you to preserve full working copies of the static content of existing websites but there are a few limitations to be aware of: