Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development Documentation Help #1913

Closed
NuclearFizzler opened this issue Feb 22, 2025 · 2 comments · Fixed by #1917
Closed

Development Documentation Help #1913

NuclearFizzler opened this issue Feb 22, 2025 · 2 comments · Fixed by #1917
Labels
documentation Improvements or additions to documentation

Comments

@NuclearFizzler
Copy link
Contributor

My teammates and I are attempting to implement #1710 and investigate #1912, and we've found some outdated information in the development documentation located at https://docs.openc3.com/docs/development/developing.

The commit implementing anycable removed the dev option from openc3.sh/bat. I assume we can just run COSMOS with openc3.sh start, but we could like to see this reflected in the docs.

I'm still trying to wrangle together the yarn environment. I'll add additional updates if we note anything.

@NuclearFizzler
Copy link
Contributor Author

NuclearFizzler commented Feb 22, 2025

I was just now able to reverse-engineer the process of how to setup the frontend to start developing with. Unfortunately, I do not have much experience with Vue development so it took me a while to figure out how the packages worked. Here are the needed updates to the documentation.

  1. To bootstrap the frontend, you must run yarn not in the openc3-cosmos-init folder, but in the init/plugin folder.
  2. You must run yarn and yarn build:common to build the plugins correctly.
  3. Running yarn serve no longer produces output showing the URL of the built webpages; I understand this is a holdover from 7a22ffa since we are running build and not preview

@jmthomas
Copy link
Member

Thanks @NuclearFizzler. We will update https://docs.openc3.com/docs/development/developing to make these changes.

@jmthomas jmthomas added the documentation Improvements or additions to documentation label Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants