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

setup docs #106

Open
v9n opened this issue Jan 17, 2025 · 3 comments
Open

setup docs #106

v9n opened this issue Jan 17, 2025 · 3 comments
Labels
documentation Improvements or additions to documentation P3 Priority Level 3

Comments

@v9n
Copy link
Member

v9n commented Jan 17, 2025

@chrisli30 https://github.com/pseudomuto/protoc-gen-doc?tab=readme-ov-file Do you think this docs style match your preference? If yes, we can use it.

@v9n v9n added documentation Improvements or additions to documentation P3 Priority Level 3 labels Jan 17, 2025
@chrisli30
Copy link
Member

We would need a .md file to display the content on our website’s /docs page. Is this the .md example, https://github.com/pseudomuto/protoc-gen-doc/blob/master/examples/doc/example.md?

Yes, this format works. One thing to note that the description of each variable as shown below needs to be well explained. Is the source of those description text the avs.proto file?
Image

@v9n
Copy link
Member Author

v9n commented Jan 17, 2025

We would need a .md file to display the content on our website’s /docs page. Is this the .md example, https://github.com/pseudomuto/protoc-gen-doc/blob/master/examples/doc/example.md?

They can generate markdown or html or pdf.they all auto gen from the inline document in protobuf.

Yes, this format works. One thing to note that the description of each variable as shown below needs to be well explained. Is the source of those description text the avs.proto file? Image

Yes, they are in proto file. We need to write them obviously

@chrisli30
Copy link
Member

Yeah, the descriptions should be simple. Cursor and ChatGPT can help!

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 P3 Priority Level 3
Projects
None yet
Development

No branches or pull requests

2 participants