Skip to content

Add develop index to the documentation#9666

Merged
andreslucena merged 1 commit intodecidim:developfrom
mainio:docs/develop-index
Sep 15, 2022
Merged

Add develop index to the documentation#9666
andreslucena merged 1 commit intodecidim:developfrom
mainio:docs/develop-index

Conversation

@ahukkanen
Copy link
Copy Markdown
Contributor

🎩 What? Why?

The documentation is currently missing this page:
https://docs.decidim.org/en/develop/index.html

I thought that this could be useful while doing other changes to the documentation.

Testing

Try to click "Develop" in the documentation site from the main navigation.

@andreslucena
Copy link
Copy Markdown
Member

I see that you didn't add the Advanced link. Just to make it explicit, this can be too big of a maintenance burden, so it's better that way, even though we aren't following the rest of the indexes pages format. We should research a way of having these indexes pages automatically, but I'm not sure if it's feasible with Antora, or we should add some automation to the build process.

Copy link
Copy Markdown
Member

@andreslucena andreslucena left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏽

@andreslucena andreslucena merged commit f7230b6 into decidim:develop Sep 15, 2022
@ahukkanen ahukkanen deleted the docs/develop-index branch September 15, 2022 09:43
@ahukkanen
Copy link
Copy Markdown
Contributor Author

I see that you didn't add the Advanced link.

The problem with that is that there is no index for the Advanced section. 😆

I just wanted to add this develop section as I think all the top level sections should at least have index pages. I know there are still some of them missing it but this particular section is something that we use a lot, so that's why.

I think it's an evolutionary process to add these eventually to make the documentation site more understandable and usable. I think each section should have a brief explanation what that section is about, so generating these automatically wouldn't solve this issue. But it would be great of course if the menu itself could be created automatically.

entantoencuanto added a commit that referenced this pull request Sep 15, 2022
* develop: (24 commits)
  Add develop index to the documentation (#9666)
  Fix initiatives components (#9633)
  Fix conference speaker avatars (#9643)
  Update `rokroskar/workflow-run-cleanup-action` GitHub action to v0.3.3 (#9750)
  Fix character counter for the WYSIWYG editor (#9680)
  Fix posting comments before the initial load has run (#9614)
  Fix parallel tests port in use (#9661)
  Split parallel test coverage reports into their own folders (#9686)
  Improve admin panel user experience regarding title links and order of actions (#9496)
  Fix title and description too long in initiatives spec sometimes (#9648)
  Fix API GraphiQL system spec with newer ChromeDriver (#9642)
  Add missing character on code block (#9798)
  Fix hidden error messages on the registration form (#9625)
  Add documentation about configuring ActiveStorage / dynamic file uploads (#9777)
  Add documentation section about customizing cells (#9622)
  Fix hashtags not recognized at the beginning of the string (#9616)
  Fix version pages showing a HTTP 500 error when the version does not exist (#9615)
  Fix multitenant organizations stats cache (#9605)
  Prevent the account edit route through Devise (#9611)
  Fix iframe disabling producing invalid HTML (#9685)
  ...
eliegaboriau pushed a commit to eliegaboriau/decidim that referenced this pull request Oct 25, 2022
@andreslucena andreslucena added the type: fix PRs that implement a fix for a bug label Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team: documentation type: fix PRs that implement a fix for a bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants