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

Updates docs to try allow better customising and removes announcment banner. #2448

Merged
merged 12 commits into from
Jul 25, 2024

Conversation

Real-MullaC
Copy link
Contributor

@Real-MullaC Real-MullaC commented Jul 24, 2024

Pull Request

Title

Updates docs to try allow better customising and removes announcment banner.

Type of Change

  • New feature
  • Bug fix
  • Documentation update
  • Refactoring
  • Hotfix
  • Security patch
  • UI/UX improvement

Description

Updates docs to try allow better customising and removes announcment banner. PR #2427 needs pushing before this PR.

Testing

I have tested this locally and banner is removed but custom css still is not.

Impact

Helps people customize the docs better.

Issue related to PR

[What issue/discussion is related to this PR (if any)]

  • Resolves no issues

Additional Information

No

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

@Real-MullaC This'll be fixed in PR #2416

Copy link
Contributor

Choose a reason for hiding this comment

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

@Real-MullaC I still think that the documentation isn't finished yet, needs more polishing & some sections to be added to it, you can change the styling & wording to not that the Documentation isn't finished but most common sections should be stable/reliable enough to use.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Check PR #2427

Copy link
Contributor

Choose a reason for hiding this comment

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

Check PR #2427

Reviewed that PR a few days ago, and still think there's room for improvement on the documentation, at the event that you think the documentation won't need to change in the next 2 years (from a UX & General Content Layout), then I'd say the docs are stable, which means we won't need this warning.

Again, if you think this warning is annoying (because of its coloring, font size, or position), then you can change the in-line CSS styling.

@ChrisTitusTech
Copy link
Owner

@Real-MullaC couple merge conflicts to work through after merging the #2427

@ChrisTitusTech ChrisTitusTech merged commit 499848d into ChrisTitusTech:main Jul 25, 2024
@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.

3 participants