junobuild/docs

The official documentation of Juno

docs's Issues

Add "no such file or directory" to Troubleshooting page

An unexpected error happened 😫. Error: ENOENT: no such file or directory, scandir 'C:\Users...\build'

We can add the solution to https://juno.build/docs/troubleshooting

Either run juno init or update the configuration in juno.json

Document list options

The various options available to listDocs and listAssets - the parameters - are not documented well enough on the website.

This feature request as for goal to improve their documentation including usage/example.

This is the TS code of the parameters.

export interface ListPaginate {
  startAfter?: string;
  limit?: number;
}

export type ListOrderField = 'keys' | 'updated_at' | 'created_at';

export interface ListOrder {
  desc: boolean;
  field: ListOrderField;
}

export type ListOwner = string | Principal;

export interface ListMatcher {
  key?: string;
  description?: string;
}

export interface ListParams {
  matcher?: ListMatcher;
  paginate?: ListPaginate;
  order?: ListOrder;
  owner?: ListOwner;
}

Make creation of collection "demo" more obvious in guides

As discussed on Discord, the step "Create demo collection" isn't that clear in the guide.

For example: https://juno.build/docs/guides/nextjs#1-set-up-a-satellite-and-new-collection

Therefore the idea is to extract the step as a dedicated step (from step 1 to step 2, and step 2 becomes step 3).

This in every guides.

Add Changelog section

Similar to blog but, with the CHANGELOGs of main repo

Add "satellite principal defined"

Looks like the term "satellite principal defined" was searched in the documentation according Agolia.
We can add it to the "troubleshooting" section.

Update stable memory limit to 400GB

document "juno config"

couldn't find "juno config" commend in document, maybe add it
(if it's existed, please ignore it)

Document new logs feature

Add google domain limitation

Google domains doesn't support CNAME for the apex domain. So, either use Cloudflare for DNS or try to use this trick: https://serverfault.com/a/714357

Add this to the documentation.

doc: note default lowercase file name

Noticed the file name is converted to lowercase by default when using API(uploadFile) to upload file, it might be worth to mention it in document.

In my case, I save the original file name(e.g. xexrEDdkiEEOX) for future reference when uploading file, but they are not match when I use it because it's lowercase(e.g. xexreddkieeox) in storage.

Style scrollbar code blocks

Particularly on the landing page, scrollbar X might appears in the code blocks if the content is larger than the width. Those scrollbars are currently not styled which looks a bit ugly given the strong border and shadow.

Improve CLI documentation for Windows Powershell

Unless we find some way to improve the CLI for Windows Powershell, users of such types of terminal have to add npm to their path if not yet present.

Therefore we can probably add a notice in the CLI about.

Something like:

:::note

If you are using Windows Powershell, after having installed the CLI please make sure npm is in your path:

C:\Users\{PC_NAME}\AppData\Roaming\npm

:::

the link doesn't work for me

can't access domain (juno.build ) with "This site can’t be reached"

Documents listDocs return

listDocs and listAssets returns various information which are currently not documented - i.e. the details of the return of the function is not document and it would be interested to document it.

export interface ListResults<T> {
  // The data - e.g. the documents or assets depending which list was called
  items: T[];
  // The numbers of items - basically items.length
  items_length: bigint;
  // If query is paginated, at what page (starting from 0) the items find place
  items_page?: bigint;
  // The total numbers of matching results
  matches_length: bigint;
  // If query is paginated, the total number (starting from 0) of pages
  matches_pages?: bigint;
}

Minimal Docker version on Macbook for local dev

Particularly for MacBooks with M processors, it is important to use Docker Desktop v4.25.0 or more recent versions, ideally the latest one.

This should be documented in the Before You Begin chapter of the "Local Development" section.

Improve FAQ with controllers

While it's mentionned multiple times on the website, the FAQ does not currently mention - I think - the fact that Juno has absolutely no control on developers satellies and mission controls.

We should verify if that's the case and if so, we should probably mention it in the FAQ too.

How to calculate sha256

Document how to calculate the sha256 of satellites and mission controls that is presented during upgrade.

List of DNS providers that does not support apex

Instead of one chapter that mentions that Google Domain does not support apex we can maybe transform it in a list

• Google Domains
• Infomaniak
• HostGator

Add E2E encoding to roadmap

Document Cloudflare settings to disable for custom domain

404 does not work as expected

I think something was broken by Docusaurus

Add config path to doc

Instead of a reference add values to doc
https://github.com/sindresorhus/env-paths#pathsconfig

Share video tutorial in a blog post

https://twitter.com/daviddalbusco/status/1683501106532429824

Please incorporate the "From zero in 5 minutes to dApp" showcase project into the Juno organization

Proposal

The showcase project should move into a separate target repository to allow an easy forking process and streamline adding static website files.

Please recognize that the initially proposed 2 minutes were too ambitious. Realistically, 4-5 minutes are required to go through the process

Resources to consider

• Repository with guide: https://github.com/dennyweiss/from-zero-in-2min-to-dapp
• Process overview
• From Zero in 2 Minutes to dApp – Intro
• From Zero in 2 Minutes to dApp – Action

"More search results" does not work

I've not been able so far to configure correctly the Algolia integration in Docusaurus to make "More search results" work as expected.

Related Docusaurus issue: facebook/docusaurus#6693

Document how to add a principal instead of login

In the "CLI > Login" section add a tips to explain that if a developer adds new satellite, it's also possible to reuse a principal already authentified locally