Welcome to Radar!
Radar is the central developer documentation hub for all of Runway Avenue’s developer projects.
This project was created because we needed a place to consolidate all the paperwork related to the wide breadth of projects we’re working across. Project whitepapers, API documentation and blog posts all are a perfect use case for this platform. Treat this as a spot for developers to share their work alongside documentation. Documentation tells a story in a lot of ways, and it’s very important for our team to be able to share that work as it unfolds to create a more interesting developer dynamic allowing the Runway Avenue platform to continue to be developed cohesively and quickly. I’d also like to leave a quote here that symbolizes our development team ideologue at Runway Avenue:
“What used to take three months to develop poorly, now takes three months to develop well. Soon, it will take the same time to develop poorly again.” - Unknown
Contributing to Radar
We hope that if you work here, you can help us expand this incredibly large index of knowledge. Our goal for Radar is that developers can learn almost everything about our company’s work and how to build better systems for Runway Avenue, just by reading the documentation that is provided by Radar. Maintaining this is hard, which is why Obsidian was a natural choice for this project (along side Quartz on the web-end). Access to contribute to Radar is currently only shared with key members who have a responsibility to contribute, but we expect this to go further as teams create branches to eventually merge documentation with Radar’s main branch, which will ultimately be uploaded here.
Start by installing the Obsidian notetaker per their website. At this point in time, any version should do just fine. Should that change, we’ll update this section with a particular version of the Obsidian notetaker and backlink it accordingly.
Once you have Obsidian installed, run:
git pull https://github.com/runwayave/radar.git [folder_path]
#Note, your subteam may be on a specific branch of Radar.
#Add a -b [branch] if needed
Then open Obsidian, and open [folder_path]/contents as an Obsidian Vault.
Now you’re all set! Update to Radar as needed, then do your usual:
git add .
git commit -m ["Commit message"]
git push
Branches will be merged as needed and trust me it will be needed. Allowing sub-teams to contribute to Radar independently as documentation becomes useful to other Runway Avenue technical team members. Refer to VPs / Directors / Managers as needed for the actual GitLab management for Radar.