Giter Club home page Giter Club logo

documentation's Introduction

CI

DataHighway Documentation

Welcome to the DataHighway Developer Hub documentation. We're just getting started, so our documentation is still incomplete.

Contributing

Refer to CONTRIBUTING.md for details about:

  • Creating Issues
  • Creating Pull Requests

Maintenance

Refer to MAINTENANCE.md for details about:

  • Updating the DataHighway Whitepaper
  • Updating the DataHighway Documentation Website
  • Deploying updates

Running & Viewing Documentation Locally

Install Node >=12.13.0, then run the following commands to install dependencies and start build the website. Optionally Obtain Algolia API keys to enable "search". Run the following, then paste them in the .env file.

cp .env.example .env

Run the following commands to install dependencies and start build the website.

yarn install && yarn start

View in web browser http://localhost:3000

Adding a New Document

  • Create your markdown document in a suitable directory inside /docs.
  • If you have images in your document, put them in the /docs/images/ directory.

documentation's People

Contributors

ashi20192020 avatar ayushmishra2005 avatar cgroeschel avatar dependabot[bot] avatar ignacio08 avatar itranscend avatar jeffstahlnecker avatar ltfschoen avatar penumbra23 avatar sbcodes avatar sheenhx avatar sudipghimire533 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

documentation's Issues

Integrate Crowdin on DataHighway docs

  • Fix so it no longer sends the generated docs to website/translated_docs/, as currently in this PR #97 is automated from Crowdin using Jeff's account and is currently generating the following (where is either ja, ko, zh-CN, zh-TW):
    website/translated_docs//getting_started/...
    website/translated_docs//tutorials/...
  • Delete PR #97
  • Modify the crowdin.yml configuration
  • Create a specific Github account for the Crowdin integration so it doesn't go through Jeff's account

References:

Conditionally hide left sidebar only on Whitepaper page and only on large viewports

In order for the Docusaurus-generated Table of Contents to turn into a hamburger menu on smaller viewports as shown below, it is necessary to show the left sidebar, but doing so takes up a lot of space on the left side of the screen.

Screenshot 2020-02-19 at 8 56 05 pm

So we need to figure out how to apply styles only to a specific page (the "Whitepaper" page only).
Since we're using Docusaurus, which generates static sites, we don't have access to the window object to conditionally apply styles depending on the current page.

A solution is that we can actually use the HTML <style> tag in specific Markdown files, where we can use media queries to only hide the left sidebar on that Whitepaper page on larger screensizes, but not on smaller screen sizes since we need it in the DOM so we can show the hamburger menu, and we also don't want to hide the left sidebar on any other page.

Screenshot 2020-02-19 at 7 31 56 pm

Fix broken links in References

404 - Not Found

  • [d7d9a7] LoRaWAN Backend Interface Specification
  • [7c63ac] MXC's Data Economy Whitepaper
  • [c63390] MXC SMB Whitepaper
  • [b26ba7] Aura
  • [7fd55a] NPoS
  • [0ec873] Substrate Executing Privileged Functions
  • [fa094e] Polkadot Token Economics Payment Details
  • [903282] Parity Proof of Authority (PoA) Chains
  • [b05a57] Polkadot Token Economics Relay Chain Transaction Fees

Only accessible with permission

  • [6fe50e] MXC Roaming Presentation by Aslan on 6th August 2019 including Activation Passive Roaming

Styles intended to hide content only intended for PDF version are appearing in production

Styles such as pdf-only were applied to the whitepaper.md file, and they hid the title and TOC in development, since they were only intended for the PDF version of the whitepaper that is generated, but in production they are not hidden for some reason (see https://dev.datahighway.com/docs/whitepaper).

Also, other aspects that should be appearing on the documentation website whitepaper such as submit-issue image are not appearing despite the CSS logic

Startup Node exception

image
image

start command:./target/release/datahighway --bootnodes /ip4/3.67.117.245/tcp/30333/p2p/12D3KooWKS7jU8ti7S5PDqCNWEj692eUSK3DLssHNwTQsto9ynVo --name "Node yjcc.pro" --chain ./chain_def_dev.json

error:Error: Input("Error parsing spec file: unknown field codeSubstitutes at line 167 column 1")

Add styles to all links in the whitepaper

Change all links in the docs/whitepaper.md i.e.[]() to HTML i.e. <a href="<LINK_ADDRESS>" target="_blank" class="pretty-link-colored"><LINK_NAME></a> so it appears coloured when you view the whitepaper in your browser. Only use target="_blank" for external links (i.e. http://test.com, but for anchor tags that are links to sections within the whitepaper (#MyLink) we actually want to remove target="_blank".)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.