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

Sync docs based on folder structure #663

Open
colmdoyle opened this issue Nov 7, 2022 · 4 comments
Open

Sync docs based on folder structure #663

colmdoyle opened this issue Nov 7, 2022 · 4 comments
Labels
command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands enhancement New feature or request

Comments

@colmdoyle
Copy link

colmdoyle commented Nov 7, 2022

I might be alone in this, but I would really love to have the CLI infer the category > page > child page relationship based on the structure of the docs folder I upload instead of burning IDs into frontmatter. As an example, if I ran docs . --version=x in the parent directory here, it would

Screenshot 2022-11-07 at 12 06 39

  • Create a category called "capabilities"
  • Create a doc for each *.md file in the capabilities directory and assign it to the category from step 1
  • for any subfolders where the directory name matches the slug of a doc in the category from step 1, create a new doc for every *.md file and make it a child page of the doc where the slug matches the folder.

Basically I want to use the CLI to abstract away the Readme UI and having to go there to generate category IDs and doc IDs is getting in the way of that workflow.

@kanadgupta kanadgupta added enhancement New feature or request command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands labels Nov 7, 2022
@rlewis-grax
Copy link

Is there any expectation for this to be worked on or discussed further? This tool is not usable for use cases that involve the management of documentation via an external VCS without this feature.

In my specific use case, documentation authors have no access to Readme and thus any dependency on using the API or UI to pull slugs/IDs to manage structure is fatal to the usability of this tool.

@kanadgupta
Copy link
Member

Hi @rlewis-grax — we're in the early stages of working on some major improvements to ReadMe's docs editing workflow so it plays much nicer with Git. Don't have an estimated timeline since it's a pretty big undertaking but it is definitely top of mind for us!

@emma-campbell
Copy link

+1 for this option and commenting to stay updated.

We also have a nested output from tools like Typedoc and Typedoc-Plugin-Markdown. The folder structure makes it much more digestible and easier to navigate.

@vegaro
Copy link

vegaro commented Jun 1, 2023

+1 for this, we are building our own scripts to sync categories and docs orders based on folder structure, but there are a lot of gotchas, like the fact that categories order cannot be changed from API

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands enhancement New feature or request
Development

No branches or pull requests

5 participants