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

[Docs 02] Auto dev-docs & more #2481

Merged
merged 84 commits into from
Aug 7, 2024

Conversation

MyDrift-user
Copy link
Contributor

@MyDrift-user MyDrift-user commented Jul 28, 2024

Pull Request

Documentation update

Type of Change

  • Documentation update

Description

There are currently 2 places per autocreated site to write custom descriptions into, which won't get overwritten by updating the files. They are marked by markdown comments in the file.

  • One on the top below the code preview
  • one at the bottom just above the link to the referenced file the source was taken from.

See the auto generated documentation on following site:

Testing

  • table of content page is created & updated sucessfully
  • documentation files are created without and issues on my side
  • linking to and from docs work
  • links are correctly added into json files

Impact

  • big impact for people who want to know how it works, but don't want to search through the .json files in the repo.

Checklist

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no errors/warnings/merge conflicts.

@MyDrift-user MyDrift-user marked this pull request as ready for review August 5, 2024 21:03
@MyDrift-user
Copy link
Contributor Author

I did get the Changelog link to the docs for the about section to work, but undid it because at the moment the github release notes and the changelog notes are not that diffrent. GitHub Releases Changelog is at the moment still superior, so it will stay that way for now.

@MyDrift-user MyDrift-user marked this pull request as draft August 6, 2024 04:59
@MyDrift-user MyDrift-user marked this pull request as ready for review August 6, 2024 17:05
Copy link
Owner

@ChrisTitusTech ChrisTitusTech left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for your work on this.

@ChrisTitusTech ChrisTitusTech merged commit 5e3c6ba into ChrisTitusTech:main Aug 7, 2024
@og-mrk og-mrk mentioned this pull request Aug 31, 2024
6 tasks
@ChrisTitusTech ChrisTitusTech added the skip-changelog Skip Change Logs label Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Skip Change Logs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants