Skip to content

feat: add xp-clifford submodule with sidebar and config integration#39

Open
gergely-szabo-sap wants to merge 4 commits intomainfrom
feat/add-clifford-docs
Open

feat: add xp-clifford submodule with sidebar and config integration#39
gergely-szabo-sap wants to merge 4 commits intomainfrom
feat/add-clifford-docs

Conversation

@gergely-szabo-sap
Copy link
Copy Markdown

Add xp-clifford as a git submodule under docs/ and integrate it into the Docusaurus site:

  • Register submodule pointing to SAP/xp-clifford.git
  • Add exclude rules in docusaurus.config.js to filter out non-docs content (subdirectories, CONTRIBUTING.md, DEVELOPMENT.md)
  • Add xp-clifford entry to the navbar dropdown menu
  • Add collapsed sidebar category with autogenerated items in sidebars.js

@jn-av
Copy link
Copy Markdown
Member

jn-av commented Apr 1, 2026

Hi @gergely-szabo-sap,

Thanks for adding clifford. The README is getting really long and has a lot of information that might not be needed for a the docs.

What do you think, does it make sense to split the docs and put them into a /docs/ folder? I think the documentation could benefit from that.

I'm also looking to migrate the docs for BTP and HANA to this format:

  • docs/end-user-guides: Hosting all end-user relevant information/docs.
  • docs/contribution-notes: Hosting all contribution-related work (ADRs, setup info if needed, special dev decisions, and more).

Do you think this structure would also make sense for clifford, or not so much?

@gergely-szabo-sap
Copy link
Copy Markdown
Author

Hi @jn-av,

Thanks for the great suggestion! I agree that restructuring the docs into a dedicated /docs/ folder makes a lot of sense. I'll adopt the structure you described (end-user-guides and contribution-notes) in the xp-clifford repository.

I'll make the changes there and update this PR accordingly once the submodule is ready.

@gergely-szabo-sap
Copy link
Copy Markdown
Author

@jn-av, I updated the xp-clifford repo here: SAP/xp-clifford#46 and applied the changes to the current repo.

Copy link
Copy Markdown
Member

@jn-av jn-av left a comment

Choose a reason for hiding this comment

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

Thanks a lot for adding the documentation. Just one thing with the submodule url, and I saw that we do not specify the order of the content in the sidebar. Can we add that?
Should be possible to add by adding this to the beginning of the files in the xp-clifford repo:

---
sidebar_position: 0
---

as seen here: https://github.com/SAP/crossplane-provider-btp/blob/main/docs/end-user-guides/account/subaccount.mdx?plain=1

.gitmodules Outdated
url = https://github.com/SAP/crossplane-provider-hana.git
[submodule "docs/xp-clifford"]
path = docs/xp-clifford
url = git@github.com:SAP/xp-clifford.git
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could we change this to the same format as the other ones?
https://github.com/SAP/xp-clifford.git

Add xp-clifford as a git submodule under docs/ and integrate it into
the Docusaurus site:

- Register submodule pointing to SAP/xp-clifford.git
- Add exclude rules in docusaurus.config.js to filter out non-docs
  content (subdirectories, CONTRIBUTING.md, DEVELOPMENT.md)
- Add xp-clifford entry to the navbar dropdown menu
- Add collapsed sidebar category with autogenerated items in sidebars.js
…lder

- Change exclude rules from README-root pattern to !(docs) pattern
- Update sidebar dirName from xp-clifford to xp-clifford/docs
- Add navbar link pointing to xp-clifford overview page
- Bump xp-clifford submodule to docs-restructured commit
@gergely-szabo-sap
Copy link
Copy Markdown
Author

@jn-av, I made the requested changes.

@gergely-szabo-sap gergely-szabo-sap requested a review from jn-av April 14, 2026 15:31
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.

2 participants