GithubHelp home page GithubHelp logo

devdocs-website's Introduction

Mage-OS DevDocs Website

This is the source of the official Mage-OS DevDocs Website.

Contribute to the Documentation

If you want to curate, edit, add or change content on the documentation, please go to the Mage-OS DevdDocs Repository.

Local Development

The website is build with Laravel. A database is not required. You can run the website locally with the following commands:

git clone [email protected]:mage-os/devdocs-website.git devdocs-website
cd devdocs-website
bash bin/setup.sh

Next, you need to compile the assets and start the server:

npm run dev
php artisan serve

Now add the documentation itself;

bash bin/checkout_latest_docs.sh

There is no container based setup. There are plenty of different setups out there, so we leave it up to you to choose your favorite one. If you want a docker-based setup, Laravel's Sail might be an option for you.

Torchlight Integration

This project relies on Torchlight for syntax highlighting. You will need to create an account at torchlight.dev and generate a free personal token for use in this project. If you used the bin/setup.sh script to setup the project, the token is in your .env file. If not, add the following line to your .env file manually:

TORCHLIGHT_TOKEN=your-torchlight-token

Syncing Upstream Changes Into Your Fork

This GitHub article provides instructions on how to pull the latest changes from this repository into your fork.

Updating After Remote Code Changes

If you pull down the upstream changes from this repository into your local repository, you'll want to update your Composer and NPM dependencies, as well as update your documentation branches. For convenience, you may run the bin/update.sh script to update these things:

./bin/update.sh

devdocs-website's People

Contributors

arronmoss avatar davidlambauer avatar dermatz avatar johnhughes1984 avatar jonashrem avatar konarshankar07 avatar mage-os-ci avatar mage-os-terraform[bot] avatar nikolalardev avatar peterjaap avatar riconeitzel avatar sprankhub avatar tjitse-e avatar vinai avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

devdocs-website's Issues

Fix flaky deployment

Still trying to figure out what the cause is, but right now, almost every deployment triggers a 503. This can be resolved by an artisan optimize:clear or similar cache-dropping methods.

Right now, we have a hotfix in place where a cron checks the site for a 503, and if so, fires the command.

This ticket is for documentation purposes...

Automatic ToC generation

Currently, the contributor in the markdown files has to make sure the ToC is added manually. Also, the jump marks need to be done manually. We could generate it I suppose.

Fix Meta Tags

Currently, there are no meta tags or schema.org/social tags for the site. Ideally, we don't have to manage those manually. The task for this issue is to come up with a concept of how we can easily manage the necessary meta tags without manually adding them everywhere.

Add Support to add images

The devdocs repo is a collection of markdown files. There is no place to upload images/screenshots or other media. Obviously, it makes sense to add different media files here and there.

We must implement a directory structure for images in the devdocs repo and render them correctly. Please consider potentially resizing the images for mobile views.

Small feedback

Awesome work on the devdocs guys! I got two small feedback points.

Darkmode

When reading code blocks, the dark mode hides the text.

Screenshot 2023-08-22 at 09 48 06

Broken search

For whatever reason the search is broken for me currently:

image

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.