Skip to content

Conversation

@a-zw
Copy link
Contributor

@a-zw a-zw commented Nov 14, 2025

So far, baselibs have no documentation in their repository, but it is stored in the score platform repo. It shall move here now that docs-as-code properly supports cross-repo linking.

This is a first PR just to introduce docs-as-code to this repo. Fixes #41

a-zw added 3 commits November 14, 2025 13:36
Why is the docname relevant for the id? If things are placed in their module repo,
there is no need to mention the feature in filenames.
Copy link
Member

@nradakovic nradakovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm reviewed PR from Build&CI side. The owner of baselibs will leave final comments on other changes.

build:bl-x86_64-qnx --extra_toolchains=@toolchains_qnx_qcc//:qcc_x86_64
test:bl-x86_64-qnx --config=bl_common

build --java_language_version=17
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Default build settings won't be hardcoded to one version. If you want to use JAVA 17 please provide proper configuration settings for it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is that Bazel requires us to hardcode it like this. We just want to use plantuml in our documentation.

Do you know any better solution?

@chheis
Copy link

chheis commented Nov 17, 2025

@a-zw
Copy link
Contributor Author

a-zw commented Nov 17, 2025

@a-zw why are you starting this here?

@chheis quoting the pr description:

So far, baselibs have no documentation in their repository, but it is stored in the score platform repo. It shall move here now that docs-as-code properly supports cross-repo linking.

@AlexanderLanin
Copy link
Member

AlexanderLanin commented Nov 17, 2025

my latest info is that baselibs wants to use TRLC and not sphinx-needs. So I guess we need to put only a basic structure here, without moving needs into this repository.

@LittleHuba ?

@4og
Copy link
Member

4og commented Nov 17, 2025

@a-zw, Thank you for submitting this PR. Unfortunately, we've also been working on integrating docs-as-code and are close to pushing the changes. Our plan is to migrate the sphinx-needs documentation from the score repository while preserving the git history, rather than simply copying files. We don't currently plan to use TLRC in this repository.

Would you be interested in joining our weekly meeting on Wednesday? I'll prepare several gh issues beforehand that we can distribute among contributors. It's to avoid duplicate work.

@a-zw
Copy link
Contributor Author

a-zw commented Nov 19, 2025

Closing this as @rahulthakre29 will do it from internally.

@a-zw a-zw closed this Nov 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs-as-code dependency

5 participants