vipulgupta2048 / firedocs

[Finished Mixster Docs] Shifted repository to firecampapp/firedocs

Hello folks, this is Vipul 🐣

Apart from my love for party parrots and vanilla, I build stuff at balena and don't just write docs at Mixster.

I write, speak, design, attend, participate and organise a ton of things over the weekends as a way of giving back to open-source. No, I don't like 2048, the game to have the same digits be in my username and I review cheesecakes in each country I visit.

📫 How to reach me: Email, Twitter and Instagram (In order of preference)
😄 Pronouns: He/Him, name pronounced as We-pull
⛰ Next trip: Let's Goto X

firedocs's Issues

[Impressions][API] Update file names

Issue: A few files in the API Impressions directory are named according to the Actions nomenclature.

Impressions naming should adhere to the following nomenclature:
Component Name
Example: GraphQL end-points

Actions naming should adhere to the following nomenclature:
Verb --> Relation(if applicable) --> Component Name
Configuring GraphQL end-points

Current Status:

The following files in api-app/impressions/are currently named inconsistently:

• Add Query Parameters.md
• What exactly are API end-points.md

Suggested changes:

• Query Parameters.md
• API end-points.md

Add Sequences to Actions

From our last call, @Nishchit14 requested indexing actions into a working list. I agree and I think this would be a great thing to have.

@Nishchit14 Can you add that link of the site which you showed me as well for Vishwa.

WebSocket doc review

GraphQL doc review

We can add the following actions in GraphQL, I am not sure it will be covered in Gesture or not but we'll discuss it.

1. Run query from the playground
2. Run mutation from the playground
3. Run subscription from the playground

Or we can combine them all in one

4. Upload file in GraphQL
5. Use of variables
6. Manage and run queries from the collection
7. Save/Push playground queries to the collection

Impression

1. Schema Document
2. Timeline in Response panel

These are my thoughts, we can discuss them in our meeting @vipulgupta2048 @mehtavishwa30

Need changes in the file structure for Gatsby theme implementation.

Hi @vipulgupta2048, I have prepared a Gatsby theme for our documentation with minimal setup. To make it functional we have to follow certain rules. I have listed the changes below. please review it and let me know once you complete it.

1. create a root directory name: source
2. move all the doc folders in source folder, like apis, graphql
3. keep all the folder names in lowercase like actions, impression etc
4. change all the file names to slug-like Configuring GraphQL endpoints.md to configuring-graphql-end-points.mdx
5. use .mdx extension instead of .md

File content changes

1. add a frontmatter block in every file like in adding-and-managing-bodies-for-your-API-request.md file add below block at top of the content

---
title: Adding & Managing bodies for your API request
subtitle: Subtitle
description: Description
---

cc @mehtavishwa30

Little things list

To be done after the docs are finalized
Actually we have a ton of little work cut out for us.

• We have to link docs together, hyperlink several words and terms to their pages.
• Make GIF's and take screenshots in the placeholders that I have left out
• Fine-tune the docs, make the tone right
• Grammarly checking of docs
• Link content to one another and find gaps.
• See where all you can add a reference to the content of Project Mgmt., and Environmental Snippet. There might be many places where they are playing a part and you missed out on writing. (I am writing this for myself)
• Alex.js the docs

Document Scripts Feature in API's

(Firecamp for Teams) Make way for TeamSync

t's a team collaboration feature. you can create a workspace in your organisation and invite other members to join. All the projects will be in sync with realtime changes.

Remove Request Methods from GraphQL

• Those that are not needed.